- نوت‌بوک اجراشده از محیط پاک، محیط و گزارش اجرا نگه دارید.
روایت علمی همراه با کد
دفترچه محاسباتی باید توضیح دهد چرا هر مرحله انجام شده است، نه اینکه فقط خروجی نرم‌افزار را نمایش دهد. هدف، منشأ داده، تبدیل‌ها، فرض‌ها و تفسیر را کنار کد بنویسید. Jupyter کد و متن و خروجی را ترکیب می‌کند؛ گزارش در R نیز باید همین منطق قابل پیگیری را حفظ کند.
خطر حالت پنهان
اجرای سلول‌ها با ترتیب متفاوت می‌تواند متغیرهای قدیمی یا نتیجه وابسته به جلسه ایجاد کند. محیط را از نو شروع و همه مراحل را از ابتدا اجرا کنید. خروجی ذخیره‌شده ممکن است متعلق به نسخه قبلی کد باشد؛ یک اجرای تمیز برای فایل قابل انتشار لازم است.
داده و محیط
نسخه زبان و بسته‌ها، دستور ایجاد محیط، بذر تصادفی و مسیر ورودی را ثبت کنید. بذر ثابت به‌تنهایی تکرارپذیری روی همه سخت‌افزارها را تضمین نمی‌کند. داده مجاز یا نمونه آموزشی برچسب‌خورده و راه دریافت داده محدود را توضیح دهید؛ اطلاعات حساس و کلید دسترسی را وارد مخزن نکنید.
ساختار و آزمون
توابع قابل استفاده مجدد را از سلول‌های طولانی جدا کنید و برای مراحل حساس، کنترل دامنه، تعداد رکورد و پاسخ معلوم تعریف کنید. از مسیر نسبی و تنظیمات مستند استفاده کنید. فایل خام، داده پردازش‌شده و خروجی را جدا نگه دارید و نتیجه هر حذف یا تبدیل را ثبت کنید.
بسته قابل تحویل
README، دستور اجرا، محیط، داده نمونه یا مسیر دسترسی، دفترچه اجراشده و خروجی مورد انتظار را همراه کنید. یک همکار باید بتواند بدون پرسیدن مراحل پنهان، جریان اصلی را اجرا کند. فایل HTML یا PDF برای مطالعه مفید است ولی جای کد و محیط لازم برای بازاجرای تحلیل را نمی‌گیرد.
چک‌لیست اجرای پژوهش
- اجرای تمیز از ابتدا موفق است.
- نسخه‌ها و دستور محیط ثبت شده‌اند.
- ورودی و خروجی و منشأ داده روشن‌اند.
- README و کنترل‌های علمی همراه فایل‌اند.
پروندۀ آموزشی و تصمیم‌های اجرایی
مثال زیر کاملاً فرضی و آموزشی است؛ از اعداد و متن آن به عنوان نتیجۀ واقعی پژوهش استفاده نکنید.
نوت‌بوک ممکن است خروجی زیبا نشان دهد ولی از متغیری استفاده کند که فقط در نشست قبلی ساخته شده است. در تمرین، kernel را پاک و همۀ سلول‌ها را به ترتیب اجرا می‌کنیم؛ اگر نام تعریف‌نشده آشکار شد، ترتیب یا منبع متغیر را اصلاح می‌کنیم. خروجی قبلی شاهد بازتولید نیست. داده، محیط، seed تصادفی در صورت کاربرد و دستور بازاجرا باید مشخص باشند. نمودار ثابت در متن را با خروجی تازه تطبیق دهید. اجرای موفق در محیط شما، اجرا در همه دستگاه‌ها را تضمین نمی‌کند.
| مرحله | نمونۀ آموزشی | پرسش کنترل |
|---|---|---|
| شروع پاک | نواة تازه و خروجی حذف‌شده | متغیر مخفی ندارد؟ |
| ترتیب | اجرای همۀ سلول‌ها از ابتدا | سلول‌ها مستقل از کلیک قبلی‌اند؟ |
| محیط | نسخۀ کتابخانه و داده | دستور نصب/اجرا روشن است؟ |
| تصادف | seed و محدودیت دستگاه | قطعی‌بودن ادعا موجه است؟ |
| تحویل | خروجی تازه و گزارش اجرا | اعداد سند با همان خروجی تطبیق دارند؟ |
خروجی تمرین: نوت‌بوک اجراشده از محیط پاک، محیط و گزارش اجرا نگه دارید.
منابع و مطالعه بیشتر
منابع رسمی برای بررسی و مطالعه بیشتر