研究方法 · 解析パッケージ
研究解析の再現パッケージを引き継ぐには:READMEと再実行の確認
渡すのはZIPだけではなく、利用許諾のある入力から指定結果までの検証可能な経路です。版、順序、環境、判定基準を記載し、別ディレクトリで再実行して差異を残します。
対象は利用権限のある公開・合成研究資料です。「受け取った共同研究者がどこから始め、結果をどう確認するか」を扱います。投稿前点検は原稿中の整合性、本頁は同じ資料とコードで結果を再生成できるかを扱います。
The Turing Wayの用法に従い、同じデータと解析手順から結果を再生成する計算再現性を指します。用語は分野で異なります。新データでの検証、別手法による頑健性の評価、一般化可能性の確認を一度の再実行で代替できません。
最小構成でも各ファイルの役割を明記する
以下は教材上の配置例であり、必須ソフトやRigorMedの出力形式ではありません。入力の入手方法と出力の生成段階を実際の研究に合わせて記載します。
| 配置例 | 記録する内容 | 受け手の確認 |
|---|---|---|
| README | 範囲、利用権限、入口、順序、期待出力、停止条件、連絡担当の役割 | 口頭説明なしに開始点と制約が分かる |
| inputs/ と data-dictionary | 出典の版またはファイルID、相対パス、単位、符号、欠測定義。再配布不可なら合法的入手方法 | 取得可能な入力が解析版と一致する |
| scripts/ と analysis-plan | 前処理、解析、表図生成の順序、パラメータ、適格基準 | 主要結果ごとに生成工程がある |
| environment | 実際のOS、言語、パッケージ版と導入方法。必要なら乱数種、スレッド、ハードウェア制約 | 単に最新版とせず指定環境で実行できる |
| expected/ と output-map | 期待ファイル、表図の対応、比較項目、事前の許容差 | 存在や丸め後の見た目ではなく内容の一致 |
| rerun-record | 実際の日付、環境、工程、終了状態、差異、未完了事項 | 未実行、失敗、一部合格と確認範囲を区別 |
秘密鍵、トークン、個人の絶対パス、共有不可の行単位資料を除きます。コードのライセンス、データ利用条件、アクセス制限は別々に明記します。ダウンロード可能でも再配布可能とは限りません。
目録を作り、旧結果に頼らず再実行する
再現対象を固定する
原稿・解析の版、主要表図、計画を指定し、探索的出力を混在させません。資料欠落や権限不明は不足事項として残し、論文から元データを逆算しません。
入力と工程と出力をつなぐ
表図ごとに入力位置、生成スクリプト、パラメータ、出力先を記録します。相対パスと依存順序を示し、手作業の判断は規則と実記録を残して自動化と称しません。
実行可能な環境と入口を記す
READMEには作成者が実際に試した導入・実行コマンド、作業ディレクトリ、順序を記します。本頁は未検証の万能コマンドを提示しません。乱数種だけではソフト、スレッド、ハードウェア間のビット単位一致を保証しません。
新しいディレクトリで動かす
元入力と正式結果を保持し、再実行結果を別に保存します。expected/の旧ファイルをコピーして計算結果としません。ネット上の入力には固定版と合法的入手経路を用い、変動する私的リンクに依存しません。
事前基準で内容を比べる
標本数、分母、変数、モデル、効果の単位を先に確認し、推定値、区間、表図データを比較します。日付など非科学的差異は別記し、浮動小数点の許容差を結果を見てから広げません。
失敗範囲を記録して引き継ぐ
実行と差異を保存します。入力欠落、依存関係エラー、主要結果の不一致があれば該当結論を止め、0の補完や手修正をしません。未実行なら再実行待ちとし、一度の成功を環境横断・品質認証としません。
合成教材: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案、確認事項です。提案仕様であり、今回の実行や顧客成果ではありません。具体的コードの実行可否は資料、能力、権限、実行前確認を別に点検します。
引継ぎ時の五つの問い
引継ぎ時の五つの問い
- 同じ版の入力を合法的に入手でき、辞書とパラメータが明確か。
- 各主要出力に生成工程があり、作者PCの手編集ファイルに依存しないか。
- 環境、コマンド、順序は実際に試され、未検証部分が明記されたか。
- 終了コード0や存在だけでなく内容、分母、単位、事前許容差を比べたか。
- 失敗、未実行、手作業、非公開部分を正直に残したか。
経路の明確さだけでは設計、バイアス対策、利用許諾、因果結論の妥当性を証明できません。PLOS方針はその出版体系に適用され、全誌共通ではありません。適用方針に沿い共有制限と合法的アクセスを説明し、機微データを公開しません。
確認済み情報源
以下の公式情報源は2026-10-21に確認済みです。公開前に条件と更新日を再確認します。
- The Turing Way:再現性の定義
同データ・同手順による再現と新データ検証の区別。分野間で用語は異なる。
- PLOS:資料・ソフトウェア・コードの共有
コード、実行文書、依存関係、テスト資料、共有制限の適用範囲。
研究の再現と成果の引継ぎ
既存資料からレビュー可能な引継ぎ案へ
RigorMedのワークスペースで資料の利用権限、手元のファイル、引継ぎ上の疑問を説明できます。対応範囲と実際の成果物を先に確認し、研究者が出典、実行記録、差異を点検してください。目録整理は再実行完了ではありません。
