המאמר ״Good enough practices in scientific computing״ פורסם ביוני 2017 בכתב העת PLOS Computational Biology, מאת גרג וילסון, ג׳ניפר בריאן, קארן קרנסטון, ג׳סטין קיצס, לקס נדרברכט וטרייסי טיל - הצוות שעמד מאחורי סדנאות Software Carpentry ו-Data Carpentry, שהגיעו לפי המאמר ליותר מ-11,000 משתתפים מאז 2010. המאמר הוא המשך ל״Best Practices for Scientific Computing״ של וילסון ואח׳ משנת 2014, אך הפעם הקהל אינו מי שכבר עוסק בחישוב כבד, אלא חוקר שעובד לבד או עם שותפים מעטים על פרויקט שנמשך ימים עד חודשים. המחברים קבעו מבחן פשוט להכללת המלצה: חוקרים רבים מאמצים אותה בפועל ועדיין משתמשים בה כעבור חודשים. נקודת המוצא שלהם היא שבלי נוהלים בסיסיים נתונים הולכים לאיבוד וניתוחים נמשכים הרבה יותר מהנדרש, ושהנהנה העיקרי מהנוהלים הוא ״האני העתידי״ של החוקר - זה שיפתח את התיקייה בעוד שלושה חודשים. בניתוח נתונים שמוגש כחוות דעת בהליך משפטי, השאלה ״איך הגעתם לתוצאה הזו״ תישאל בהכרח, ולכן עקרונות הליבה שבמאמר - נתוני גלם שנשמרים כפי שהתקבלו, תיעוד של כל שלב עיבוד, מעקב אחר שינויים וסקריפט אחד שמריץ את הניתוח מתחילתו - הם תנאי ליכולת להגן על העבודה. המלצות השיתוף והפרסום שבמאמר, כמו הפקדת נתונים וקוד במאגר ציבורי ורישיונות פתוחים, נועדו למחקר אקדמי ואינן חלות על נתונים חסויים של תיק או של לקוח: אלה נשמרים בסביבה סגורה, לפי הוראות הסודיות שקבע בית המשפט או לפי ההסכם.
למה נתוני הגלם חייבים להישאר כפי שהתקבלו?
התשובה של המאמר: כי נתוני הגלם הם הדבר היחיד שמאפשר להתאושש מטעות בניתוח. ההמלצות בפרק ניהול הנתונים:
- לשמור את נתוני הגלם בדיוק כפי שנוצרו, ולהגדיר את הקבצים לקריאה בלבד (או להגן עליהם בגיליון האלקטרוני), כך שקשה לפגוע בהם או לערוך אותם ידנית בטעות. כאשר המקור הוא מאגר חיצוני גדול שלא מעשי להעתיק, רושמים את הנוהל המדויק שבו הנתונים הושגו, כולל מספר גרסה רשמי או תאריך הורדה.
- לגבות את נתוני הגלם ביותר ממקום אחד, רצוי גם מחוץ לאתר.
- לייצר את הנתונים שהיינו רוצים לראות בעולם: להמיר פורמטים סגורים לפורמטים פתוחים (CSV, JSON, YAML, XML, HDF5), להחליף קודים סתומים כמו ״-99״ בערך NA המקובל, ולתת לקבצים שמות שמכילים מידע אך נשמרים בתבנית קבועה. הדוגמה במאמר היא 2016-05-alaska-b.csv, שם שמאפשר לאדם ולתוכנה לבחור קבצים לפי שנה או מיקום.
- ליצור נתונים נוחים לניתוח: כל עמודה היא משתנה אחד וכל שורה היא תצפית אחת. האיור במאמר מראה כיצד טבלה ״רחבה״, שבה כל נקודת זמן היא עמודה, מקופלת לטבלה ״ארוכה״.
- לתעד כל שלב עיבוד, רצוי בסקריפט. כאשר אין ברירה אלא לבצע פעולה ידנית, מתעדים אותה בכתב.
- להיערך לטבלאות מרובות: לכל רשומה מזהה ייחודי וקבוע, הכתוב באותה צורה בכל הטבלאות (״14025״ ולא ״14,025״ בטבלה אחת ו-״014025״ באחרת).
- להפקיד את הנתונים במאגר שמנפיק DOI (המאמר מזכיר Figshare, Dryad ו-Zenodo), בליווי קובץ README לקוראים אנושיים. המאמר מבחין בין מטא-דאטה על מערך הנתונים כולו לבין מטא-דאטה על תוכנו, וממליץ למלא מטא-דאטה פורמלי אם מנועי איסוף אוטומטיים אמורים להשתמש בו.
המאמר מוסיף שכדאי לשמור גם קבצי ביניים, מפני שהם מקלים להריץ מחדש ולשנות את שרשרת העיבוד.
איך מארגנים את תיקיית הפרויקט?
המאמר מציע מבנה אחיד: תיקייה אחת לכל פרויקט, הנושאת את שמו, ובתוכה doc למסמכי טקסט, data לנתוני הגלם ולמטא-דאטה, results לתוצרים שנוצרו בניתוח, src לקוד המקור ו-bin לתוכנות מהודרות (אם יש). בשורש התיקייה יושבים README, LICENSE, CITATION וקובץ התלויות requirements.txt. הדוגמה במאמר היא פרויקט ספירת ציפורים: הקובץ birds_count_table.csv ב-data, קובצי notebook.md, manuscript.md ויומן השינויים ב-doc, summarized_results.csv ב-results, וב-src הסקריפט sightings_analysis.py לצד סקריפט בקרה בשם runall.py.
הכלל המרכזי לשמות קבצים: שם לפי התוכן, לא לפי מספר סידורי ולא לפי מיקום במאמר. result1.csv ו-fig_3_a.png הם דוגמאות למה שאין לעשות.
איך עוקבים אחרי שינויים בלי לאבד את הדרך?
המאמר מציג עקרונות שחלים על כל שיטה, ואחריהם שני מסלולים ליישום. העקרונות: לגבות כמעט הכול מיד עם היווצרו, לשמור כל שינוי קטן, לשתף שינויים בתדירות גבוהה, להחזיק רשימת תיוג לשמירה ולשיתוף (הודעות ברורות, הנחיות על גודל ותוכן של כל שינוי, ואיסור על שמירת עבודה חצי גמורה או קוד שבור), ולשקף את תיקיית הפרויקט מחוץ למחשב העבודה, לפחות פעם ביום.
המסלול הראשון הוא ניהול ידני: קובץ CHANGELOG בתיקיית doc, עם רשומות מתוארכות מהחדש לישן, כעין מחברת מעבדה; ואחרי כל שינוי משמעותי, העתקה של הפרויקט כולו לתיקיית משנה מתוארכת (למשל 2016-03-01) לצד התיקייה הנוכחית, בתוך תיקייה שמסונכרנת לאחסון חיצוני. הנימוק: ״נתונים זולים, זמן יקר״. כונן של טרה-בייט עולה כ-50 דולר. כשיש כמה שותפים, כל אחד מנהל יומן נפרד והיומנים ממוזגים בעת הגיבוי.
המסלול השני הוא מערכת ניהול גרסאות כמו Git (המאמר מזכיר גם Mercurial ו-Subversion): היא שומרת תמונות מצב, רושמת מי שינה מה ומתי, מסמנת עריכות חופפות כהתנגשות, ומסנכרנת בין עותקים. GitHub, GitLab ו-Bitbucket מוזכרים כשירותי אירוח.
חשוב לא פחות מה לא מכניסים לניהול גרסאות: קבצים בינאריים כמו docx ו-PDF, שבהם אי אפשר להצביע על שינוי נקודתי; קובצי CSV שסדר השורות או העמודות שלהם משתנה, מפני שהם מייצרים הבדלים גדולים גם כשהנתונים לא השתנו; נתוני גלם, שממילא אינם אמורים להשתנות; תוצרי ביניים גדולים שאפשר לייצר מחדש; קבצים מעל 100 מגה-בייט (המגבלה של GitHub לקובץ בודד); ונתונים רגישים מבחינה משפטית, כמו מידע רפואי, שאסור להעלות למאגר ציבורי. סיסמאות ומפתחות פרטיים אינם נכנסים לעולם.
איך כותבים קוד שאפשר לקרוא וגם להריץ מחדש?
- לפתוח כל תוכנית בהערה קצרה שמסבירה מה היא עושה, כולל דוגמאות שימוש.
- לפרק את התוכנית לפונקציות קצרות, בסדר גודל של עמוד או פחות.
- לבטל כפילויות, ולהשתמש במבני נתונים במקום בסדרת משתנים כמעט זהים.
- לחפש קודם ספרייה מתוחזקת שעושה את העבודה, ולבדוק אותה לפני שסומכים עליה.
- לתת שמות בעלי משמעות לפונקציות ולמשתנים.
- לפרט את התלויות במפורש, למשל בקובץ requirements.txt.
- לא לשנות התנהגות על ידי הפיכת שורות להערות והחזרתן, אלא באמצעות תנאים.
- לספק מערך נתונים קטן לדוגמה, שמאפשר בדיקת תקינות מהירה.
- להפקיד גם את הקוד במאגר שמנפיק DOI.
בנוסף, המאמר ממליץ על סקריפט בקרה אחד (runall) שמכיל את כל שלבי הניתוח מתחילתו ועד סופו, עם הפרמטרים וקובצי הקלט והפלט, ושומר הפרדה בינו לבין ״הקרביים המדעיים״ של הניתוח. בדוגמה שבמאמר שם התיקייה הזמנית נשמר במשתנה אחד, כדי שלא יחזור על עצמו בכמה מקומות.
מה נדרש כדי שגם אחרים יוכלו לעבוד על הפרויקט?
לפי המאמר, קובץ README צריך לכלול את שם הפרויקט, תיאור קצר, פרטי קשר מעודכנים ודוגמה או שתיים להרצת ניקוי או ניתוח. קובץ CONTRIBUTING מסביר איך מתקינים את התלויות, איזו בדיקה מאשרת שההתקנה תקינה, ואילו הנחיות ורשימות תיוג הפרויקט מקיים. רשימת משימות משותפת מנוהלת בקובץ טקסט (notes.txt או todo.txt) או במנגנון ה-issues של שירות האירוח, עם תיאור ברור דיו למצטרפים חדשים. יש להחליט מראש על ערוצי תקשורת, ולהצהיר במפורש על הרישיון: CC-0 או CC-BY לנתונים ולטקסט, ורישיון פתוח מתירני כמו MIT, BSD או Apache לתוכנה. המאמר ממליץ להימנע מגרסאות ״לא מסחרי״ של Creative Commons ומרישיון GPL, משיקולי שימוש חוזר. קובץ CITATION מסביר כיצד לצטט את הפרויקט.
לכתיבת המסמך עצמו המאמר מציע שתי דרכים: כלי מקוון עם עיצוב, מעקב שינויים וניהול מקורות (כמו Google Docs), או טקסט פשוט תחת ניהול גרסאות (LaTeX או Markdown, עם המרה באמצעות Pandoc). ההמלצה היא להסכים על שיטת העבודה לפני שמתחילים לכתוב.
מה המאמר משאיר בכוונה בחוץ?
המחברים מונים במפורש נוהלים שהשאירו מחוץ לרשימה: ענפים בניהול גרסאות, כלי בנייה, בדיקות יחידה, מדידת כיסוי, אינטגרציה רציפה, מדידת ביצועים, תיעוד נרחב, מנהלי ביבליוגרפיה וסקירת קוד. אלה משתלמים בעיקר בפרויקטים גדולים. המסקנה שלהם מופנית לראשי מעבדות, לאוניברסיטאות, לספרנים ולגופי מימון: אם דורשים מחוקרים לעמוד בחובות של ניהול נתונים, צריך גם ללמד אותם כיצד.
מה אומר הדין הישראלי על מקורות ועל שלמות נתונים?
תקנה 87(ז) לתקנות סדר הדין האזרחי קובעת שלחוות דעת מומחה ״תצורף רשימת האסמכתאות שהמומחה מסתמך עליהן״, ושאסמכתאות ״שלא ניתן לאתרן בנקיטת אמצעים סבירים״ יצורפו לחוות הדעת עצמה. התקנה עוסקת באסמכתאות ולא בנתונים או בקוד, אבל ניהול נתונים כפי שהמאמר ממליץ מאפשר לתת לצד השני גישה דומה גם אליהם: לנתוני הגלם כפי שהתקבלו ולכל שלב עיבוד. וכשנתוני הגלם כוללים מידע אישי, סעיף 3 לחוק הגנת הפרטיות מגדיר ״שלמות המידע״ כ״זהות הנתונים במאגר מידע למקור שממנו נשאבו, בלא ששונו, נמסרו או הושמדו ללא רשות כדין״, ניסוח קרוב מאוד לכלל הראשון של המאמר: לשמור את נתוני הגלם כפי שהתקבלו.
מקורות
- Wilson, G., Bryan, J., Cranston, K., Kitzes, J., Nederbragt, L. & Teal, T. K. (2017). Good enough practices in scientific computing. PLOS Computational Biology 13(6): e1005510. רישיון CC-BY 4.0.
- Wilson, G. et al. (2014). Best Practices for Scientific Computing. PLOS Biology 12(1): e1001745. רישיון CC-BY.
- Noble, W. S. (2009). A Quick Guide to Organizing Computational Biology Projects. PLOS Computational Biology 5(7): e1000424. רישיון CC-BY.
- Sandve, G. K., Nekrutenko, A., Taylor, J. & Hovig, E. (2013). Ten Simple Rules for Reproducible Computational Research. PLOS Computational Biology 9(10): e1003285. רישיון CC-BY.
- תקנות סדר הדין האזרחי, התשע״ט-2018, תקנה 87(ז).
- חוק הגנת הפרטיות, התשמ״א-1981, סעיף 3 (הגדרת ״שלמות המידע״).