研究方法 · 分析套件交接
科研分析重現套件怎麼交接?從README到重跑驗收
交接的不是一個壓縮檔,而是從已授權輸入到指定結果的可檢查路徑。先寫明版本、順序、環境與判據,再讓接收者於隔離目錄重跑並記錄差異。
本頁適用於有權使用的公開或合成研究材料,回答「合作者拿到檔案後,從哪裡開始、如何核對結果」。投稿檢查頁處理稿件數字與證據的一致性;這裡處理結果能否沿相同材料與程式重新產生。
本文採The Turing Way的計算重現定義:同一資料及分析步驟重新得到結果。各學科術語可能不同;使用新資料驗證、換方法檢查穩健性及證明可推廣性,不能由一次重跑替代。
最小交接目錄:每個檔案都要有用途
下列名稱是教學組織建議,並非必裝軟體或本站匯出格式。按真實專案調整,說明輸入如何取得、輸出由哪一步產生。
| 位置範例 | 應說明什麼 | 接收者如何核對 |
|---|---|---|
| README | 研究範圍、材料權限、入口、順序、預期輸出、停止條件與聯絡角色 | 不靠口頭補充也知道起點與限制 |
| inputs/ 與 data-dictionary | 來源版本或檔案ID、相對路徑、單位、編碼與缺失約定;不能再散布時提供合法取得說明 | 輸入可取得且與分析版本一致 |
| scripts/ 與 analysis-plan | 清理、分析、表圖產生順序、參數及納排規則 | 每項結果都有生成步驟,不是手抄數字 |
| environment | 實際作業系統、語言及套件版本、安裝說明;適用時記種子、執行緒與硬體限制 | 能於聲明環境執行,不只寫「最新版」 |
| expected/ 與 output-map | 預期檔案、表圖對應、比對欄位及預定容差 | 不以檔案存在或四捨五入後相似代替一致 |
| rerun-record | 實際日期、環境、步驟、結束狀態、差異與未完成項 | 區分未跑、失敗、部分通過與核對範圍 |
交接前移除密鑰、權杖、個人絕對路徑與不可公開的列級材料。程式授權、資料使用條件及存取限制分開說明;可下載不等於可再散布。
先建清單,再做不借用舊結果的重跑
鎖定重現目標
指定稿件或分析版本、主要表圖與方案,不混入探索性輸出。材料缺失或權限不明先列缺口,不能從論文反推原始資料。
連接輸入、步驟與輸出
為每張表圖記輸入位置、生成程式、參數與輸出路徑;採相對路徑並列依賴。人工選擇需有決定規則及實際記錄,不能藏成自動化。
寫出可執行環境與入口
README填實際驗證過的安裝與執行指令、工作目錄及順序;本文不提供未核驗的通用指令,原作者應於套件填寫。種子不保證跨軟體、執行緒或硬體逐位相同。
在新目錄執行
保留原始材料與正式輸出,將新結果存於獨立目錄;不能直接複製expected舊檔當新產物。網路來源需固定版本及合法取得路徑,不依賴會變動的私人連結。
按預定判據比對內容
先比樣本量、分母、變數、模型與效應單位,再比估計、區間及表圖資料。日期等非科學差異另列;浮點容差須預定,不能事後放寬直到通過。
記錄失敗邊界再交付
保存執行與差異紀錄。缺輸入、依賴失敗或關鍵結果不符就停止相關結論,不補零、不手改輸出。檔案齊但未跑只寫待重跑;一次成功不是跨環境或品質認證。
合成教學片段:不能只驗收「有CSV」
自寫教學輸入一欄x,共5列:1、2、3、4與一個空白。僅此算術範例預定計算非空值平均,不插補;核對總列5、有效4、缺失1、平均2.5。不是患者資料、真實研究、統計建議或產品實跑。
輸出映射可將summary.csv的n_total/n_valid/n_missing/mean_x對應README檢查項;重跑紀錄另記實際指令、環境與比對情形。產生寫著2.5的檔案不證明計算執行過。
若平均為2.0,先查是否把空白填0;若有效數變5,追查解析或前處理規則,不先改期望值。交接需公開規則及分母,不只交付外觀相同的表格。
讓AI整理交接缺口,不替你宣告成功
建議材料:有權使用的檔案目錄、公開或合成資料字典、現有README、已確認執行說明及去識別執行摘要。不要為整理清單上傳患者列、憑證或無權分享全文。
建議輸入:僅按提供材料,以「目標結果—輸入版本/位置—步驟/參數—輸出—驗收欄位—缺口」整理交接表與README草稿。無指令、版本或執行證據就列待確認,不編環境、結果或通過紀錄。
可請求交接表、README草稿與待確認項;這是建議規格,不是本輪執行或客戶成效。具體程式能否執行,需另核材料、能力、權限及執行前確認。
交付時的五個問題
交付時的五個問題
- 能合法取得相同版本輸入,且字典、參數明確嗎?
- 每個關鍵輸出都有生成步驟,而非作者電腦上的手工檔嗎?
- 環境、指令、順序有實際驗證,未驗證部分已標明嗎?
- 比對內容、分母、單位及預定容差,而不只看結束碼0或檔案存在嗎?
- 失敗、未跑、人工步驟及不能公開部分有如實記錄嗎?
重現路徑清楚不證明設計、偏倚控制、授權或因果結論正確。PLOS政策是該出版體系的具體要求,不代表所有期刊;限制分享時依適用政策說明原因與合法存取方式,不公開敏感資料。
核驗來源
以下官方來源核驗於 2026-10-21,發布前將再次檢查存取條件與更新時間。
- The Turing Way:重現術語與定義
同資料、同分析路徑的重現與新資料驗證之別;術語非跨學科統一。
- PLOS:材料、軟體與程式共享政策
程式、執行文件、依賴、測試材料及共享限制,適用範圍依現行政策。
研究重現與交付
把現有材料整理為可審閱的交接說明
在RigorMed工作台說明材料權限、已有檔案與交接問題,可改寫上述輸入。先確認處理範圍與實際交付,再由研究者核對來源、執行及差異;清單整理不等於完成重跑。
