パイプライン設定ファイルについて
=======================================

.. code-block:: bash

  process.executor = 'uge'
  process.penv = 'def_slot'
  process.errorStrategy = 'retry'
  process.maxRetries = 2

  params {
      ref_fa = '/share/pub/hgc_ppl/CovidPipeLine/1.0.0/database/NC_045512/NC_045512.fasta'
      amino_acid_letter_code_file = '/share/pub/hgc_ppl/CovidPipeLine/1.0.0/main/python/aa_list.tsv'

      //tool
      trimmomatic = '/share/pub/hgc_ppl/CovidPipeLine/1.0.0/tool/Trimmomatic/Trimmomatic-0.39/trimmomatic-0.39.jar'
      bamsort = '/share/pub/genomon/.genomon_local/genomon_pipeline-2.6.3/install/biobambam-0.0.191/src/bamsort'
      bammarkdup = '/share/pub/genomon/.genomon_local/genomon_pipeline-2.6.3/install/biobambam-0.0.191/src/bammarkduplicates'
      library_path = '/share/pub/genomon/.genomon_local/genomon_pipeline-2.6.3/local/lib/'
      fisher = '/share/pub/genomon/.genomon_local/genomon_pipeline-2.6.3/local/python2.7-packages/bin/fisher'
      python_path = '/share/pub/genomon/.genomon_local/genomon_pipeline-2.6.3/local/python2.7-packages/lib/python'
      python_home  = '/share/pub/genomon/.genomon_local/genomon_pipeline-2.6.3/local/python/2.7.10' 
      python_lib = '/share/pub/genomon/.genomon_local/genomon_pipeline-2.6.3/local/python2.7-packages/lib:/share/pub/genomon/.genomon_local/genomon_pipeline-2.6.3/local/lib/'
      //trimmomatic
      trimmomatic_enable = true

      trimmomatic_option = 'ILLUMINACLIP:/share/pub/hgc_ppl/CovidPipeLine/1.0.0/tool/Trimmomatic/Trimmomatic-0.39/adapters/TruSeq3-PE.fa:2:30:10 \
                            LEADING:3 \
                            TRAILING:3 \
                            SLIDINGWINDOW:4:15 \
                            MINLEN:36 '

      //align
      bwa_option = ' -T 0 '

      bamsort_option = 'index=1 \
                        level=1 \
                        inputthreads=2 \
                        outputthreads=2 \
                        calmdnm=1 \
                        calmdnmrecompindentonly=1 '

      bammarkdup_option = 'markthreads=2 \
                           rewritebam=1 \
                           rewritebamlevel=1 \
                           index=1 \
                           md5=1  '

      //mutation call
      mutation_call_enable = true
      fisher_option = ' --min_depth 100 \
                        --base_quality 20 \
                        --min_variant_read 50 \
                        --min_allele_freq 0.0001 \
                        --post_10_q 0'

      fisher_samtools_params = '-q 20 \
                                -BQ0 \
                                -d 10000000 \
                                --ff UNMAP,SECONDARY,QCFAIL'

      //bcftools
      bcftools_enable = true
      pangolin_dir = '/share/pub/hgc_ppl/CovidPipeLine/1.0.0/tool/miniconda3'
    
  }

  process  {

      withName: trimmomatic {
      cpus = 1
      maxForks = 100
      clusterOptions = '-S /bin/bash -cwd   -l s_vmem=6G  '
      }

      withName: align {
      cpus = 1
      maxForks = 100
      clusterOptions = '-S /bin/bash -cwd   -l s_vmem=6G  '
      }

      withName: mutation_call {
      cpus = 1
      maxForks = 100
      clusterOptions = '-S /bin/bash -cwd   -l s_vmem=8G  '
      }

      withName: bcftools {
      cpus = 1
      maxForks = 100
      clusterOptions = '-S /bin/bash -cwd   -l s_vmem=6G  '
      }

  }

.. note::

  **リファレンスゲノム**

  | このパイプラインで使っているリファレンスゲノム
  | ( /share/pub/hgc_ppl/CovidPipeLine/1.0.0/database/NC_045512/NC_045512.fasta ) は `NC_045512 の NC_045512.2 バージョン <https://www.ncbi.nlm.nih.gov/nuccore/1798174254>`_ を使っています。

ジョブで実行するツールの設定
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


.. csv-table:: configの設定
    :header: 項目, 説明

    ref_fa, リファレンスファイルのパス
    amino_acid_letter_code_file, アミノ酸の1文字表記と3文字表記が書かれたファイルのパス
    trimmomatic,  trimmomaticのパス
    bamsort, bamsortのパス
    bammarkdup, bammarkdupのパス
    library_path, libのパス
    fisher, GenomonFisherのパス
    python_path, libのパス
    python_home, PYTHONHOMEのパス
    python_lib, libのパス
    trimmomatic_enable, "trueの場合, trimmomaticを実行します。"
    trimmomatic_option, trimmomaticのオプションを設定します。
    bwa_option, bwaのオプションを設定します。
    bamsort_option, bamsortのオプションを設定します。
    bammarkdup_option, bammarkdupのオプションを設定します。
    mutation_call_enable, "trueの場合, mutation callを実行します。"
    fisher_option, Genomon Fisherのオプションを設定します。
    fisher_samtools_params, Genomon Fisherの-Sオプションを使う場合に設定します。
    bcftools_enable, "trueの場合, bcftoolsを実行します。"
    pangolin_dir, pangolinをインストールしたcondaのディレクトリパス
       

| 設定を変更するときは「=」の右側の文字を書き換えてください。
|
| 例えば

.. code-block:: bash

  trimmomatic_enable = true

| の場合はtrue

.. code-block:: bash

  trimmomatic_enable = false

| の場合はfalseを設定したことになります。
|
| 数値などのクオテーションで囲まれた中身を変更するときはクオテーション(')は残しておいてください。
|
| 例えば

.. code-block:: bash

  bwa_option = ' -T 0 '

| の場合は-T 0

.. code-block:: bash

  bwa_option = '-T 1 '

| の場合は-T 1を設定したことになります。
|
|



ジョブの設定
^^^^^^^^^^^^^^^^^^^^^^^^^^^

| 例えばtrimmomaticのジョブについてCPUコアを1個, メモリを5GBに設定する場合は下のようになります。

.. code-block:: bash

  withName:  trimmomatic  {
  cpus = 1
  maxForks = 100
  clusterOptions = '-S /bin/bash -cwd -l s_vmem=5G'
  }

| s_vmemは1コアあたりのメモリ量でcpusはCPUコア数になります。