CNVの検出
===================

| 生成したbamファイルをもとにCNV ( コピー数変異 ) を検出します。

PARABRICKS CNVKIT
^^^^^^^^^^^^^^^^^

|
| 出力結果はcnnファイル、cnrファイル、cnsファイルとして生成します。
| cnnファイル、cnrファイル、cnsファイルはテキストファイルなので、
| そのままlessコマンドで見ることができます。( :ref:`less` )
|
| ファイルの見方は https://cnvkit.readthedocs.io/en/stable/fileformats.html?highlight=cns を見てください。
|
| このパイプラインではgrepコマンドでcnsとcnrから特定の染色体を抽出した後
| オリジナルのcnvkitを使ってscatter.pngとdiagram.pdfを作成します。
|
| pngファイルやpdfファイルは そのままで見ることができないので
| scpコマンドを使って自分のpcにダウンロードしてからファイルを開きます。( :ref:`scp` )
| ファイルを開くとCNVが検出されていることがわかります。
|
| 図の見方は https://cnvkit.readthedocs.io/en/stable/plots.html?highlight=pdf を見てください。

 
Sequenza
^^^^^^^^^

| Sequenzaはがんのサンプルのbamファイルと正常なサンプルのbamファイルを使って
| cellularity(腫瘍細胞含有率)やploidy(倍数性)の推定、コピー数の計算をします。

.. csv-table:: 出力ファイル一覧
  :header: ファイル名, 説明
  :widths: 7, 7 

  {サンプル名}_all_small_out.seqz.gz_ab_[ all | 1 - 22 | X | Y ].pdf, Gene wide overview ( Allele-specific copy number )
  {サンプル名}_all_small_out.seqz.gz_baf_[ 1 - 22 | X | Y ].pdf, Chromosome view
  {サンプル名}_all_small_out.seqz.gz_cnv_[ all | 1 - 22 | X | Y ].pdf, Gene wide overview ( Total copy number )
  {サンプル名}_all_small_out.seqz.gz_cellularity.pdf, それぞれのcellularityのposterior probability
  {サンプル名}_all_small_out.seqz.gz_cellularity.txt, posterior probabilityが最大となるときのcellularity
  {サンプル名}_all_small_out.seqz.gz_ploidy.txt, posterior probabilityが最大となるときのploidy
  {サンプル名}_all_small_out.seqz.gz_seq_tab.tsv, Segments results
  {サンプル名}_all_small_out.seqz.gz_hrd_loh.txt, LOH score

.. note::

  **リファレンスファイルについて**

  | Sequenzaはhg19で動くのでCrossMapでbamファイルをhg38からhg19に変換して
  | Sequenzaを実行します。
  | 実行後はhg38に戻しません。
  | Sequenza以外のツールはhg38で実行します。

.. note::

  **non_matching_normal_fileについて**

  | bamファイルを動作確認用に置いてあります。(/home/kks_th/CaGMeJ_git/SRC/v8/database/sequenza/hg19_5929_tumor.sorted.bam)
  | 適宜設定してください。

| Sequenzaについては
| https://cran.r-project.org/web/packages/sequenza/vignettes/sequenza.html
| https://sequenza-utils.readthedocs.io/en/latest/
| を参考にしてください。



.. note::

  **set +e**

  | sequenzaのRスクリプトがエラーを出力しても止まらないようにしています。

FACETS
^^^^^^^^^

| FACETSはがんのサンプルのbamファイルと正常なサンプルのbamファイルを使って
| アレル特異的コピー数解析をします。

.. csv-table:: 出力ファイル一覧(fit=emcncf(oo))
  :header: ファイル名, 説明
  :widths: 7, 7

  {サンプル名}.out.fit.tsv, "rbind( fit$purity, fit$ploidy, fit$dipLogR, fit$cncf, fit$emflags )"
  {サンプル名}.out.logR.tsv, oo$dipLogR
  {サンプル名}.out.png, "genome-wide profile(logR, logOR, copy number)" 
  {サンプル名}.out.purity.tsv, fit$purity

| https://sites.google.com/site/mskfacets/
| https://github.com/mskcc/facets
| https://pubmed.ncbi.nlm.nih.gov/27270079/
| を参考にしてください。

.. note::

  **snp-pileup**

  | このパイプラインではbamファイルをregionごとに読み込むように
  | snp-pileupを改変しています。

.. note::

  **バグ**

  | facetsのv0.6.2では
  | segidの計算処理に関するバグがあります。(facets-clustersegs.Rの中の変数)
  | このパイプラインではそのバグを修正しています。

.. note::

  **purityがNAの場合**

  | facetsではsegment内のヘテロなgermline変異に対して
  | tumor, normal x non-ref, refの2x2の組み合わせでリード数をもとにオッズ比を計算します。
  | 対数オッズ比の絶対値が分散に対して小さい場合purityがNAになります。


.. note::

  **ファイルシステム関連のエラー**

  | 破損したbamファイルを使ってsnp-pileupを実行しても正常終了するケースがありました。
  | bamファイルが破損していた場合に異常終了するようにsnp-pileupを改変しました。

CNVkit
^^^^^^^^^

| CNVkitはがんのサンプルのbamファイルと正常なサンプルのbamファイルを使って
| ゲノム全体のコピー数変異を検出します。

| https://cnvkit.readthedocs.io/en/stable/pipeline.html
| を参考にしてください。

| 出力ディレクトリはcnvkit_compareです。
| :ref:`dna_output` を参考にしてください。


.. note::

  **性別不明**

  | このパイプラインではサンプルの性別が不明の場合は
  | is_male_reference = not self.guess_xx(verbose=False)で性別を推測しています。
  | 推測した結果はis_male_reference.txtとして出力して、
  | その結果をもとに下流での--male-referenceのオプションのbool値を判断します。
  |
  | サンプルとreferenceの性別が異なるとscatter, cnr, cnsのX染色体のlogの値が1ずれます。

.. note::

  **cnvkit.py call(腫瘍率による補正)**

  | cnvkit.py callはcnsファイルのlog2 ratioをもとにcopy numberを計算します。
  |
  | このパイプラインではcnvkit.py callのオプションに
  | -m clonal --purity {腫瘍率(FACETSのout.purity.tsvの値)}
  | を用いて腫瘍率による補正をしています。
  | FACETSのout.purity.tsvの値がNAの場合はスキップします。

  .. csv-table:: 腫瘍率による補正をした出力ファイル一覧
   :header: ファイル名
   :widths: 17

   {サンプル名}.purity_calibrated.call.cns
   {サンプル名}.purity_calibrated.call.cns.vcf
   {サンプル名}-scatter_purity_calibrated.png
   {サンプル名}-diagram_purity_calibrated.pdf

Battenberg
^^^^^^^^^^^

| Battenbergはがんのサンプルのbamファイルと正常なサンプルのbamファイルを使って( データの種類はWGS(全ゲノム) )
| subclonal copy numberを検出します。

| https://github.com/Wedge-lab/battenberg
| を参考にしてください。

.. note::

  **改変**

  | SHIROKANE上で実行できるように改変しています。