Cách liên kết mã với các ấn phẩm

Các bài báo học thuật về điện toán khoa học (và nhiều lĩnh vực khác, ngày nay) thường liên quan đến một số lượng mã hoặc thậm chí toàn bộ gói phần mềm được viết riêng cho bài báo đó hoặc được sử dụng để thu được kết quả trong bài báo. Cách tốt nhất để giúp người đọc của bài báo truy cập mã là gì? Cách tiếp cận hiện tại của tôi là đặt một liên kết đến kho lưu trữ Github (cùng với thẻ phiên bản cụ thể) trong bài báo hoặc trong trích dẫn.

Vâng, tôi nghĩ rằng bạn có một vài lựa chọn.

1. Nếu bạn có một trang ổn định, chẳng hạn như một trang được tài trợ bởi một trường đại học hoặc tổ chức phi lợi nhuận khác không có khả năng biến mất bất cứ lúc nào sớm, bạn có thể xuất bản ở đó.
2. Bạn có thể sử dụng một dịch vụ như Github hoặc Bitbucket hoặc SourceForge để phân phối mã.
3. Nếu mã có giá trị chung cận biên (đó là mã phân tích cho một tập hợp các điều kiện cụ thể, v.v.), bạn có thể cung cấp mã dưới dạng "thông tin bổ sung" với giấy mà bạn sử dụng.
4. Bạn có thể sử dụng một số kết hợp ở trên.

Tuy nhiên, trong bất kỳ hoặc tất cả các trường hợp này, bạn nên chỉ rõ nguồn cung cấp rõ ràng trong bài viết và cho biết loại giấy phép đó là gì (GPL, Creative Commons, v.v.), để không xảy ra sự cố liên quan đến IP.

Câu hỏi tuyệt vời và câu trả lời tuyệt vời, nhưng tôi nghĩ không ai giải quyết được câu hỏi về sự kiên trì đầy đủ, nếu mục tiêu là đạt được cùng tiêu chuẩn phù hợp với chính ấn phẩm. (Điều này có thể ngớ ngẩn khi có cơ hội mã vẫn chạy , nhưng ít nhất vẫn có thể hữu ích như tất cả các ấn phẩm như nhau).

Trang web của trường đại học bổ sung không kiên trì

Các trang web của trường đại học không có khả năng cung cấp sự ổn định hoặc dự phòng để bảo tồn nội dung được lưu trữ. Nội dung khó trích dẫn hơn và thường thiếu siêu dữ liệu có thể đọc được của máy.

Thật không may, có vẻ như các tạp chí không làm tốt hơn trong việc duy trì các tài liệu bổ sung của họ (xem Anderson et al. 2006 ), và có thể không chấp nhận các định dạng cần thiết, hoặc thậm chí chấp nhận tài liệu bổ sung (xem một ví dụ đáng chú ý ).

Vì những lý do này, những người quan tâm đến việc lưu trữ dữ liệu lâu dài đã nhất trí chuyển sang ủng hộ việc sử dụng các kho lưu trữ chuyên dụng thay vì các trang web hoặc tài liệu bổ sung, và nhiều tạp chí hiện bắt buộc thực hành này . Dường như chỉ có công bằng rằng mã được tổ chức theo tiêu chuẩn này.

Giải pháp của nhiều bản sao?

Github và các trang web liên quan vẫn chưa chứng minh được tuổi thọ trong quy mô 100 năm đạt được của các thư viện đại học và các nhà xuất bản được thành lập. Bằng cách tạo điều kiện phân phối rộng rãi, nó có thể cung cấp một giải pháp mà những người khác đã lặp lại trong các bình luận, bao gồm cả một người không thể bình luận về stackexchange,

... Chúng ta hãy tiết kiệm những gì còn lại: không phải bằng kho tiền và khóa mà chúng che khuất chúng khỏi mắt công chúng và sử dụng để ký gửi chúng lãng phí thời gian, mà bằng cách nhân lên các bản sao như vậy, sẽ đặt chúng ngoài tầm với của tai nạn.

- Thomas Jefferson, ngày 18 tháng 2 năm 1791

Figshare & tiêu chuẩn CLOCKSS

Tiêu chuẩn lưu trữ duy nhất mà tôi biết là figshare , có thể chấp nhận kho lưu trữ mã đầy đủ (dưới dạng "tập tin" vào lúc này, nhưng tôi tin rằng sẽ sớm có tùy chọn được liệt kê dưới dạng "mã"). Mấu chốt của figshare không chỉ là DOI có thể sử dụng được với siêu dữ liệu lập trình, mà còn là sự hỗ trợ của dịch vụ lưu trữ CLOCKSS , duy trì các bản sao của tất cả nội dung của nó tại 12 nút phân phối địa lý và chính trị trên toàn thế giới. Nếu figshare ngừng hoạt động hoặc ngừng tồn tại, điều này sẽ kích hoạt tất cả nội dung của nó được cung cấp miễn phí từ CLOCKSS.

Do đó, tôi khuyên bạn nên sử dụng Github để phân phối mã, nhưng cũng cung cấp một bản sao lưu trữ cho figshare tại thời điểm xuất bản.

Bạn có thể sử dụng một số kỹ thuật pdf ưa thích để chỉ cần đính kèm mã vào pdf (nghĩa là các tệp mã được nhúng vào pdf và có thể được "tải xuống" bằng cách nhấp vào nút nào đó trong pdf). Điều này có thể được thực hiện với gói đính kèm , ví dụ. Tất nhiên, điều này hoạt động với các bản in sẵn (mặc dù tôi không biết nếu nó đã hoạt động với arxiv) nhưng bạn có thể gặp vấn đề với các tệp nhật ký ...

Đối với các tập lệnh nhỏ dành riêng cho một dự án nghiên cứu cụ thể, nơi tốt nhất để xuất bản là trang web của tạp chí, là "thông tin bổ sung" cho bài báo. Đó là nơi dễ tìm nhất cho người đọc bài báo.

Các gói quan trọng hơn cũng được quan tâm cho các dự án khác cũng nên được xuất bản riêng. Thật không may, không có giải pháp thực sự tốt tại thời điểm này. Lý tưởng nhất là một ấn phẩm mã sẽ có thể truy cập vĩnh viễn thông qua DOI, giống như một tờ giấy, nhưng tôi không biết bất kỳ trang web lưu trữ nào cung cấp DOI và đảm bảo tính lâu dài của chúng. Các kho lưu trữ công cộng như Github hoặc Bitbucket có lẽ là lựa chọn tốt nhất hiện nay.

Giải pháp tốt nhất là xuất bản giấy được đóng gói với mã và dữ liệu đi kèm với nó, nhưng điều đó vẫn chưa khả thi về mặt kỹ thuật. Tôi đang làm việc trên một nguyên mẫu nghiên cứu khám phá ý tưởng này, xem trang web này để biết chi tiết.

Tôi đã thực hiện hai chiến thuật, xuất phát từ thực tế là tôi dự đoán sẽ sớm thay đổi các tổ chức, vì vậy URL của trường đại học của tôi không ổn định trong một chút.

Khi mã tương đối ngắn, tôi đã thử đưa nó vào như một phụ lục bổ sung trong chính tạp chí, với giả định rằng họ có thể sẽ làm tốt công việc giữ giấy và mã ở cùng một chỗ. Điều này đặc biệt hữu ích cho mã khi không có nhiều lợi ích chung - mã đó hơi vô dụng nếu không có bài viết để cung cấp ngữ cảnh.

Nhưng đối với mã nguồn, phần mềm thực tế và các dự án phức tạp hơn hoặc những dự án quan tâm chung, tôi đã tuân theo chiến thuật liên kết với kho lưu trữ GitHub của bạn, ít nhất là ổn định cho tuổi thọ sản xuất trung bình của các bài báo của tôi.

Hãy xem http://www.runmycode.org . Họ lưu trữ các trang web đồng hành cho mã liên quan đến các tài liệu nghiên cứu. Nếu mã là R, Matlab hoặc một vài mã khác, nó thực sự sẽ chạy mã cho bạn. Tôi chưa thử, nhưng tôi dự định. Tôi nghĩ David Donoho và cộng tác viên của mình sử dụng nó.

Thư viện đại học có thể là nơi dành cho việc này hoặc trung tâm lưu trữ của trường đại học.

Là một người đọc, một tuyên bố trong bài báo về tác động mà mã có thể thu được bằng cách liên hệ trực tiếp với tác giả sẽ có hiệu lực. Là một tác giả, điều này có thể giúp thúc đẩy sự hợp tác và cho tôi cơ hội nhắc nhở mọi người trích dẫn bài viết của tôi nếu họ sử dụng mã trong công việc của họ.