Module-QIIME2_BetaSig

This entry was posted in QIIME2 on by

DOC_ID : T15-0002

QIIME2_BetaSig module : 

DOC_ID : M56-3000
Editor : Anita
Reviewer :Angela

Function :

QIIME BetaSig module perform analyze sample composition in the context of categorical metadata using PERMANOVA (first described in Anderson (2001)) using the beta-group-significance command. The detail function and output file list below:

  1. Jaccard distance (a qualitative measure of community dissimilarity) : (fieldName=’A:B’)*
    • jaccard_distance_matrix.qza ⇒ jaccard-A-group-significance.qzv
    • jaccard_distance_matrix.qza ⇒ jaccard-B-group-significance.qzv
  2. Bray-Curtis distance (a quantitative measure of community dissimilarity) :
    • bray_curtis_distance_matrix.qza  ⇒ bray_curtis-A-group-significance.qzv
    • bray_curtis_distance_matrix.qza  ⇒ bray_curtis-B-group-significance.qzv
  3. unweighted UniFrac distance (a qualitative measure of community dissimilarity that incorporates phylogenetic relationships between the features) : 
    • unweighted_unifrac_distance_matrix.qza ⇒ unweighted-unifrac-A-group-significance.qzv
    • unweighted_unifrac_distance_matrix.qza ⇒ unweighted-unifrac-B-group-significance.qzv
  4. weighted UniFrac distance (a quantitative measure of community dissimilarity that incorporates phylogenetic relationships between the features) : 
    • weighted_unifrac_distance_matrix.qza ⇒ weighted_unifrac-A-group-significance.qzv
    • weighted_unifrac_distance_matrix.qza ⇒ weighted_unifrac-B-group-significance.qzv
     

Ref : https://docs.qiime2.org/2021.8/tutorials/moving-pictures/#alpha-and-beta-diversity-analysis

Installation :

All software are included in GA environment. 

Note :

►執行分析前請先利用CreateProject.sh創建一個專案資料夾，請參閱Project standard folder structure文件。

►執行模組需確認所屬計算節點(–partition) : 一般節點的使用者建議使用ct56 ; 生醫節點的使用者建議使用ngs24G註1。

►欲了解模組使用的方式，請執行模組的 -h 指令
 

#註1 : 欲確認使用者身分，請登入國網中心iService後，選取會員中心/計畫管理/我的計畫，若計畫名稱為”國家生醫數位資料與分析運算雲端服務平台III”即為生醫節點使用者

Description :

Tested environmentGAQM20.0.0.2
Software versionqiime2=2021.8.0=py38h5479fe0_0
Usage(Slurm)Command in Slurm (Taiwania III)Further analysis the column in metadata (by categoricalList file)
sbatch -A $projectID --mail-user=$email --export='projDir='$(pwd)'/,metaData='q2metadata.tsv',betaDiversityFile=jaccard_distance_matrix.qza' modules/QIIME2_BetaSig.sh
 Further analysis the column in metadata (by user input)
sbatch -A $projectID --mail-user=$email --export='projDir='$(pwd)'/,metaData='q2metadata.tsv',betaDiversityFile=jaccard_distance_matrix.qza,fieldName=Subject:sex' modules/QIIME2_BetaSig.sh
Usage(Linux console)Command in linux consoleFurther analysis the column in metadata (by categoricalList file)
bash modules/QIIME2_BetaSig.sh -p $(pwd) -m q2metadata.tsv -B jaccard_distance_matrix.qza
 Further analysis the column in metadata (by user input)
bash modules/QIIME2_BetaSig.sh -p $(pwd) -m q2metadata.tsv -B jaccard_distance_matrix.qza -f Subject:sex

Usage :

The following explains the usage of module parameters :

Parameter DescriptionRemark
QIIME2_BetaSig.shModule of diversity analysis分析的模組需存放在[modules]資料夾中
projDir分析專案的資料夾路徑（專案資料夾結構說明）Script需在分析專案的資料夾執行，$(pwd) 會傳回使用者現在所在的路徑
metaData欲執行分析的樣品元數據檔案，相關格式要求可參考文件或官網資料格式 : *.tsv資料路徑 : 分析專案的資料夾►此檔案在建置時要注意每個欄位不可以有單獨sample為一個組別的情形例如:metaData=q2metadata.tsv是讀取存放在projDir裡的q2metadata.tsv檔案
betaDiversityFile欲進行beta-group significance analysis的檔案資料格式 : *_distance_matrix.qza►此參數可設定的檔案目前只有4個，分別為 :jaccard_distance_matrix.qzabray_curtis_distance_matrix.qzaunweighted_unifrac_distance_matrix.qzaweighted_unifrac_distance_matrix.qza例如:betaDiversityFile=jaccard_distance_matrix.qza，是將report/core-metrics-results/ 資料夾下的jaccard_distance_matrix.qza 搭配metaData檔案裡的categorical type的欄位做進一步分析
fieldName設定進行beta-group significance analysis的樣品元數據檔案內之欄位名稱，欄位類別須為categorical►此參數為選擇性參數，若欲分析的欄位多於一個，請在參數設定欄位名稱中以冒號(:)做間隔(e.g. Subject:sex)例如 : fieldName=Subject 會再將metaData檔案裡的Subject欄位做進一步分析例如 : fieldName=Subject:sex 會再將metaData檔案裡的Subject及sex欄位做進一步分析
►也可以將欲進行分析的categorical type之欄位先寫成一份檔案，以檔案型式帶入，這種方式不須另外設定參數，相關規定如下 :檔名須為categoricalList.tsv欄位與欄位之間須以Tab作間隔例如:將欲進行分析的categorical type之欄位先寫成一份categoricalList.tsv檔案，存放在projDir下，程式會自動去讀取檔案內的欄位名稱做進一步分析

Leave a comment