DNAサンプル設定ファイルについて
===============================

項目は13種類あります．

+-----------------+---------------------------------------------------+
| [fastq]         | FASTQファイルを入力として解析します               |
+-----------------+---------------------------------------------------+
| [bam_import]    | BAMファイルを入力として解析します                 |
+-----------------+---------------------------------------------------+
| [cram_import]   | CRAMファイルを入力として解析します                |
+-----------------+---------------------------------------------------+
| [mutation_call] | 変異コールが実行されます                          |
+-----------------+---------------------------------------------------+
| [sv_detection]  | SV検出が実行されます                              |
+-----------------+---------------------------------------------------+
| [MSI]           | MSIsensorが実行されます。                         |
+-----------------+---------------------------------------------------+
| [haplotype]     | PARABRICKS HAPLOTYPECALLERが実行されます。        |
+-----------------+---------------------------------------------------+
| [deepvariant]   | PARABRICKS DEEPVARIANTが実行されます。            |
+-----------------+---------------------------------------------------+
| [manta]         | Mantaが実行されます。                             |
+-----------------+---------------------------------------------------+
| [facets]        | facetsが実行されます。                            |
+-----------------+---------------------------------------------------+
| [gridss]        | GRIDSSが実行されます。                            |
+-----------------+---------------------------------------------------+
| [cnvkit_compare]| CNVkitが実行されます。                            |
+-----------------+---------------------------------------------------+
| [mimcall]       | MIMcallが実行されます。                           |
+-----------------+---------------------------------------------------+
| [chord]         | CHORDが実行されます。                             |
+-----------------+---------------------------------------------------+
| [survirus]      | SurVirusが実行されます。                          |
+-----------------+---------------------------------------------------+
| [ascatngs]      | ascatNGSが実行されます。                          |
+-----------------+---------------------------------------------------+
| [battenberg]    | battenbergが実行されます。                        |
+-----------------+---------------------------------------------------+


[fastq]の記載方法
^^^^^^^^^^^^^^^^^

| {サンプル名}
| {fastqファイル1_1},{fastqファイル1_2},{RG1 (read group情報)}
| {fastqファイル2_1},{fastqファイル2_2},{RG2 (read group情報)}
| のように分割されたfastqファイルのパスを記入してください。
|

|
| 区切り文字は,(カンマ)でお願いします。
| サンプル名は自分で自由に決められます。
| 他のサンプルのサンプル名と重複しないように注意してください。
| fastqファイル1-1~30-1とfastqファイル1-2~30-2にはペアエンドリードのfastqファイルの絶対パスを設定してください。絶対パスは/homeから始まるパスになります。 ( :ref:`pwd` )
| 圧縮したfastqファイルでも動きます。
| 拡張子に.gzがついている場合、圧縮ファイルとして取り扱います。


.. code-block:: bash

  [fastq]
  tumor
  /home/username/tumor10_1.fq,/home/username/tumor10_2.fq,@RG\tID:tumor1.flowcel.lane0.barcode\tLB:Library\tPL:ILLUMINA\tSM:tumor1\tPU:flowcel.lane0.barcode\tPM:NOVASEQ\tCN:Takarabio
  /home/username/tumor11_1.fq,/home/username/tumor11_2.fq,@RG\tID:tumor1.flowcel.lane1.barcode\tLB:Library\tPL:ILLUMINA\tSM:tumor1\tPU:flowcel.lane1.barcode\tPM:NOVASEQ\tCN:Takarabio
  normal
  /home/username/normal_1.fq,/home/username/normal_2.fq,@RG\tID:normal.flowcel.lane1.barcode\tLB:Library\tPL:ILLUMINA\tSM:normal\tPU:flowcel.lane1.barcode\tPM:NOVASEQ\tCN:Takarabio
 
| ここに記入したfastqファイルをマッピングしてbamファイルを出力します。
| またすべてのbamファイルに対してquality controlやNGSCheckMateも実行されます。

[bam_import]の記載方法
^^^^^^^^^^^^^^^^^^^^^^

| {サンプル名},{bamファイル1}のように記入してください。
| 区切り文字は,(カンマ)でお願いします。
| サンプル名は自分で自由に決められます。
| 他のサンプルのサンプル名と重複しないように注意してください。
| bamファイルにはbamファイルの絶対パスを設定してください。絶対パスは/homeから始まるパスになります。 ( :ref:`pwd` )
| bamファイルと同じフォルダにbaiファイルを置いてください。

.. code-block:: bash

  [bam_import]
  tumor,/home/username/tumor.bam
  normal,/home/username/normal.bam

[cram_import]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^

| {サンプル名},{cramファイル1}のように記入してください。
| 区切り文字は,(カンマ)でお願いします。
| サンプル名は自分で自由に決められます。
| 他のサンプルのサンプル名と重複しないように注意してください。
| cramファイルにはcramファイルの絶対パスを設定してください。絶対パスは/homeから始まるパスになります。 ( :ref:`pwd` )
| cramファイルと同じフォルダにcraiファイルを置いてください。

.. code-block:: bash

  [cram_import]
  tumor,/home/username/tumor.cram
  normal,/home/username/normal.cram

[mutation_call]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使って変異検出のツールに渡すbamファイルを設定します。
|
| Tumorサンプル,Normalサンプル,controlpanel
| の順にカンマ (,) 区切りで記載してください。
|
| controlpanelは使えるようにしていないのでNoneにしておいてください。 
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|
|
| TumorサンプルのみでNormalサンプルを使わない場合はNoneを設定してください。
| NormalサンプルをNoneにした場合はparabricks mutectcallerは動きません。

.. csv-table:: 
   :header: ツール, パターン
   :widths: 6, 6

   PARABRICKS MUTECT CALLER, TumorサンプルとNormalサンプル
   PARABRICKS CNVKIT, Tumorサンプルのみ
   Sequenza, TumorサンプルとNormalサンプル
   GenomonFisher, TumorサンプルとNormalサンプル または Tumorサンプルのみ
   cgpPindel, TumorサンプルとNormalサンプル
 
|
| controlpanelについてはGenomonを参考にしてください。( https://genomon.readthedocs.io/ja/latest/dna_sample_csv.html )
| Genomonを実行するための設定になります。

.. code-block:: bash

  [mutation_call]
  tumor,normal,None
  tumor,None,None


[sv_detection]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってSV検出のツールに渡すbamファイルを設定します
| Tumorサンプル,Normalサンプル,controlpanel
| の順にカンマ (,) 区切りで記載してください。
|
| controlpanelは使えるようにしていないのでNoneにしておいてください。
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|

.. csv-table:: 
   :header: ツール, パターン
   :widths: 6, 6

   ITD Assembler, Tumorサンプルのみ
   GenomonSV, TumorサンプルとNormalサンプル または Tumorサンプルのみ

|
| TumorサンプルのみでNormalサンプルを使わない場合はNoneを設定してください。

.. code-block:: bash

  [sv_detect]
  tumor,normal,None
  tumor,None,None

  
[MSI]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってMSI検出のツールに渡すbamファイルを設定します。
| Tumorサンプル,Normalサンプル
| の順にカンマ (,) 区切りで記載してください。
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|

.. csv-table:: 
   :header: ツール, パターン
   :widths: 6, 6

   MSIsensor-pro, TumorサンプルとNormalサンプル または Tumorサンプルのみ

|
| TumorサンプルのみでNormalサンプルを使わない場合はNoneを設定してください。

.. code-block:: bash

  [MSI]
  tumor,normal
  tumor,None

[haplotype]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってPARABRICKS HAPLOTYPECALLERに渡すbamファイルを設定します。
|
| サンプル名を記載してください。


.. code-block:: bash

  [haplotype]
  tumor
  normal

[deepvariant]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってPARABRICKS DEEPVARIANTに渡すbamファイルを設定します。
|
| サンプル名を記載してください。


.. code-block:: bash

  [deepvariant]
  tumor
  normal

[manta]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってMantaに渡すbamファイルを設定します。
| Tumorサンプル,Normalサンプル,解析の種類(somaticまたはgermline)
| の順にカンマ (,) 区切りで記載してください。
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|

.. csv-table:: 
   :header: ツール, パターン
   :widths: 6, 6

   Manta, TumorサンプルとNormalサンプル または Tumorサンプルのみ

|
| TumorサンプルのみでNormalサンプルを使わない場合はNoneを設定してください。

.. code-block:: bash

  [manta]
  tumor,normal,somatic
  normal,None,germline

[facets]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってfacetsに渡すbamファイルを設定します。
| Tumorサンプル,Normalサンプル
| の順にカンマ (,) 区切りで記載してください。
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|

.. csv-table:: 
   :header: ツール, パターン
   :widths: 6, 6

   facets, TumorサンプルとNormalサンプル

.. code-block:: bash

  [facets]
  tumor,normal

[gridss]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってGRIDSSに渡すbamファイルを設定します。
| Tumorサンプル,Normalサンプル
| の順にカンマ (,) 区切りで記載してください。
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|

.. csv-table::
   :header: ツール, パターン
   :widths: 6, 6

   GRIDSS, TumorサンプルとNormalサンプル または Tumorサンプルのみ

| TumorサンプルのみでNormalサンプルを使わない場合はNoneを設定してください。

.. code-block:: bash

  [gridss]
  tumor,normal
  tumor,None

[cnvkit_compare]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってCNVkitに渡すbamファイルを設定します。
| Tumorサンプル,Normalサンプル,症例の性別(T:男性, F:女性, N:不明)
| の順にカンマ (,) 区切りで記載してください。
|
| 症例の性別はcnvkit.py batchでの--male-referenceオプションに使います。
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|

.. csv-table::
   :header: ツール, パターン
   :widths: 6, 6

   CNVkit, TumorサンプルとNormalサンプル

.. code-block:: bash

  [cnvkit_compare]
  tumor,normal,T
  tumor,normal,F
  tumor,normal,N

[mimcall]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってMIMcallに渡すbamファイルを設定します。
| Tumorサンプル,Normalサンプル
| の順にカンマ (,) 区切りで記載してください。
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|

.. csv-table::
   :header: ツール, パターン
   :widths: 6, 6

   MIMcall, TumorサンプルとNormalサンプル

.. code-block:: bash

  [mimcall]
  tumor,normal


[chord]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってCHORDに渡すbamファイルを設定します。
|
| GRIDSSとPARABRICKS MUTECT CALLERで指定したTumorサンプルとNormalサンプルの
| 中から解析したい組み合わせを選び、Tumorサンプル名だけを記載してください。
|

.. code-block:: bash

  [haplotype]
  tumor

[survirus]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってSurVirusに渡すbamファイルを設定します。
|
| サンプル名を記載してください。
|

.. code-block:: bash

  [survirus]
  tumor

[ascatngs]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってascatNGSに渡すbamファイルを設定します。
| Tumorサンプル,Normalサンプル,症例の性別(XY:男性, XX:女性, L:不明)
| の順にカンマ (,) 区切りで記載してください。
|
| 症例の性別はascatNGSでの-genderオプションに使います。
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|

.. csv-table::
   :header: ツール, パターン
   :widths: 6, 6

   ascatNGS, TumorサンプルとNormalサンプル

.. code-block:: bash

  [ascatngs]
  tumor,normal,XY
  tumor,normal,XX
  tumor,normal,L

[battenberg]の記載方法
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| [fastq]で設定したサンプル名を使ってBattenbergに渡すbamファイルを設定します。
| Tumorサンプル,Normalサンプル,症例の性別(T:男性, F:女性)
| の順にカンマ (,) 区切りで記載してください。
|
| TumorサンプルとNormalサンプルは重複しないようにしてください。
|

.. csv-table::
   :header: ツール, パターン
   :widths: 6, 6

   Battenberg, TumorサンプルとNormalサンプル

.. code-block:: bash

  [battenberg]
  tumor,normal,T
  tumor,normal,F