研究データの整理方法:フォルダ構成と説明書を作る

入力・コード・出力を分け、README とデータ辞書で意味を伝えます。4 行のサンプルデータと、日本語の記入例をダウンロードできます。

言語日本語

元データ・分析コード・結果を分ける

研究データを整理するときは、元の入力、分析コード、再生成できる結果を別々のフォルダに置きます。プロジェクトの直下に README、データのそばに列の意味を説明するデータ辞書を用意すると、初めて見る人も作業を始めやすくなります。

パス役割
README.md研究の目的、実行手順、期待結果を説明する。
data/sessions.csv書き換えずに保管する入力データ。
data/data-dictionary.md列の意味、単位、許される値を説明する。
analysis/analyze.pyデータから平均を計算するスクリプト。
results/means.csvスクリプトで再生成できる結果。

これらは study-sessions/ フォルダ内の相対パスです。元データはそのまま残し、整形や変換をしたファイルには別の名前を付け、作成手順を記録してください。この例では sessions.csv が入力、means.csv が出力なので、後者は再実行で置き換えられます。

4 行のサンプルデータをダウンロードできます。実在する参加者のデータではありません。

データ辞書に列の意味と単位を書く

minutes という列名だけで、すべてが伝わるとは限りません。何を測った値か、単位は何か、どの値を受け付けるかを記録します。

列名意味この例で許される値
session_id学習セッションの識別子S01 など、重複しない文字列。
conditionセッション中の音の条件quiet または background-noise。
minutes記録された学習時間(分)0 以上の整数。

この 4 行の例は 3 列とも必須で、欠測値はありません。実際の研究では、空欄や特定の記号など、欠測値の表し方と分析での扱いを別途決めてください。「0 分だった」と「記録がない」は異なります。識別子を実在する人の氏名に置き換える必要もありません。

README に目的・入力・実行方法・結果を書く

最初に研究の問いとデータの由来を書き、次に入力、実行方法、結果の確認先を示します。列ごとの詳しい説明はデータ辞書へリンクしましょう。

この例では 4 件の架空データを使い、2 種類の音の条件で平均学習時間を計算します。列の定義は data/data-dictionary.md にあります。入力は data/sessions.csv です。プロジェクトのルートで python analysis/analyze.py を実行し、results/means.csv を確認します。

実データなら収集期間、アクセス方法、前処理の記録も追加してください。フォルダを共有する前に、個人を特定できる情報や公開できない記録が含まれていないか確認します。

日本語 README の記入例と日本語データ辞書の記入例を出発点にできます。Markdown ファイルなので、自分の研究に合わせて書き換えられます。これらは説明書であり、実行に必要なデータとコードは別です。

今すぐコードも試したい場合は、成果パッケージを作る章(英語)に完全なダウンロードと実行手順があります。ZIP 内の既存 README は英語・中国語・韓国語です。今回の日本語記入例は上のリンクから個別に取得できます。

練習:説明書だけでファイルを見つけられるか

自分のプロジェクトで clean-final2.csv のような曖昧な名前をひとつ探し、中身が伝わる名前に変えてください。元ファイルと生成手順を書き、読み込み先のスクリプトも更新します。

確認のしかたを見る

README を共同研究者に渡し、元データ、ある列の単位、再生成できる出力を指してもらいます。推測が必要だった箇所に説明を加えましょう。この例なら、入力は data/sessions.csv、時間の単位は分、再生成できる出力は results/means.csv です。

参考資料とライセンス

本章は The Turing Way Community の著作物(Copyright © The Turing Way Community、CC BY 4.0)を基に構成しています。Miss Formula が英語版を編集基準として日本語で説明を再構成し、計算例と練習問題を追加しました。原典の図やデータは転載していません。