İyi Bir Veri Kümesi README'si Yazmak

Verinizin ön kapısı

Bir README, bir veri kümesini açıklayan sade, insan tarafından okunabilir bir dosyadır. Yeniden kullanan birinin açtığı ilk şeydir ve çoğu zaman yeniden kullanılan veri ile terk edilen veri arasındaki farktır. İyi bir tane yazmak dakikalar alır, herkese saatler kazandırır.

Nelere yer verilmeli

• Başlık ve özet — veri kümesinin ne olduğu, bir iki cümleyle.
• Üreticiler ve iletişim — kimin yaptığı ve nasıl ulaşılacağı.
• Dosyalar — dosyaların listesi ve her birinin ne içerdiği.
• Değişkenler — her sütun/alan; birimleri ve kodlarıyla açıklanmış (örneğin "-99" ya da "NA" ne anlama geliyor).
• Yöntemler — verinin nasıl toplandığı ya da üretildiği.
• Lisans — yeniden kullanım koşulları.
• Atıf — veri kümesine nasıl atıf yapılmasını istediğiniz, ideal olarak DOI'siyle.

Bir yabancı için yazın

Okuyucunun alanınızı bildiğini ama sizin özel projeniz hakkında hiçbir şey bilmediğini varsayın. Kısaltmaları açın, varsayımları belirtin ve yalnızca sizin aklınızda ya da laboratuvar defterinizde olan bağlama asla güvenmeyin.

Kazancı

İyi bir README, verinizi FAIR anlamında Bulunabilir ve Yeniden Kullanılabilir kılar, "bu sütun ne demek?" diye gelen e-postaları azaltır ve çalışmanızın atıf alma olasılığını çok artırır.