# 学習時間の再現可能な分析：README 記入例

## 目的とデータの由来

2 種類の音の条件で、平均学習時間を計算します。4 件の記録は学習用の架空データです。音の効果について科学的な結論を出すためのデータではありません。

## ファイル

| パス | 役割 |
| --- | --- |
| `data/sessions.csv` | 入力データ。 |
| `data/data-dictionary.md` | 列の意味、単位、欠測値の扱い。 |
| `analysis/analyze.py` | 条件ごとに平均時間を計算するスクリプト。 |
| `expected/means.csv` | 実行結果と照合する参照表。 |
| `results/means.csv` | 実行後に生成される出力。 |

これは README の記入例です。このファイルだけでは分析できません。完全な学習用 ZIP は https://missformula.com/guides/assets/example/study-sessions-reproducibility-package.zip から取得できます。ZIP のファイル配置は上の表に対応しています。日本語のデータ辞書は https://missformula.com/guides/assets/example/data-dictionary-ja.md で個別に公開しています。

## 実行と照合

展開した `study-sessions/` フォルダで実行します。

```sh
python --version
python analysis/analyze.py
```

環境によっては `python` を `python3` または `py -3` に置き換えてください。スクリプトは Python 3 の標準ライブラリだけを使います。実行環境の記録には、自分が確認した Python の正確なバージョンと OS を記入します。

`results/means.csv` と `expected/means.csv` を比較します。期待する平均は `background-noise` が 20.0 分、`quiet` が 25.0 分です。再実行すると生成済みの結果表は置き換えられます。

## 自分の研究に合わせる

研究の問い、入力の由来とバージョン、利用申請の方法、実行コマンド、確認済みの環境、コードのリビジョン、期待結果、データとコードのライセンスを記録してください。架空データだけで試せる場合は、実研究との入力・結果の違いも説明します。
