Skip to content

Commit

Permalink
Add mb-validate doc
Browse files Browse the repository at this point in the history
  • Loading branch information
komstat committed Jan 27, 2025
1 parent a02f436 commit 6fcc49a
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,42 @@
# Metabobank tools

## mb-validate

IDF/SDRF/データファイルをチェック。[ルール](https://www.ddbj.nig.ac.jp/metabobank/validation-e.html)

```
singularity exec mb-tools.simg mb-validate -i IDF [-s SDRF] [-t BioSample tsv] [-o output directory of corrected file] [-a] [-m md5 checksum file] [-d]
```

* -i: IDF を指定(必須)
* -s: SDRF を指定。無い場合は IDF のパスから導出。例 study/MTBKS1/MTBKS1.idf.txt → study/MTBKS1/MTBKS1.sdrf.txt(任意)
* -t: BioSample tsv を指定。ある場合は BioSample との整合性チェックを実施(任意)
* -o: auto-correct された IDF/SDRF ファイルの出力ディレクトリ。デフォルトは IDF と同じ場所に MTBKS1.corrected.idf.txt のように生成(任意)
* -a: auto-correct を実施。デフォルトは未実施(任意)
* -m: md5 値を md5sum コマンドの出力ファイルとして指定。指定した場合、SDRF 中の md5 値は無視される(任意)
* -d: データファイル (raw, processed, maf) のチェックを実施

使い方の例

* auto-correct 無し
* データファイルチェック有り

```
singularity exec mb-tools.simg mb-validate -i study/MTBKS302/MTBKS302.idf.txt -d
```

加えて md5 値を MTBKS302.md ファイルとして指定。

```
singularity exec mb-tools.simg mb-validate -i study/MTBKS302/MTBKS302.idf.txt -d -m MTBKS302.md
```

* auto-correct 有り
* データファイルチェック無し
```
singularity exec mb-tools.simg mb-validate -i study/MTBKS302/MTBKS302.idf.txt -a
```

## mbexcel2idfsdrf.rb

MetaboBank metadata excel から IDF/SDRF tsv ファイルを生成
Expand Down

0 comments on commit 6fcc49a

Please sign in to comment.