Module-QIIME2_Emperor

This entry was posted in QIIME2 on by

DOC_ID : T15-0002

QIIME2_Emperor module : 

DOC_ID : M57-3000
Editor : Anita
Reviewer :Angela

Function :

Ordination is a popular approach for exploring microbial community composition in the context of sample metadata.QIIME2_Emperor module use the Emperor tool to explore principal coordinates (PCoA) plots in the context of sample metadata. While qiime diversity core-metrics-phylogenetic command did already generate some Emperor plots, official website want to pass an optional parameter, –p-custom-axes, which is very useful for exploring time series data. The PCoA results that were used in core-metrics-phylogeny are also available, making it easy to generate new visualizations with Emperor.
The detail function and output file list below: 

  1. Jaccard pcoa results : (columnName=’111:222′)*
    • jaccard_pcoa_results.qza ⇒ jaccard-111-emperor_plot.qzv
    • jaccard_pcoa_results.qza ⇒ jaccard-222-emperor_plot.qzv
  2. Bray-Curtis pcoa results :
    • bray_curtis_pcoa_results.qza  ⇒ bray_curtis-111-emperor_plot.qzv
    • bray_curtis_pcoa_results.qza  ⇒ bray_curtis-222-emperor_plot.qzv
  3. unweighted UniFrac pcoa results : 
    • unweighted_unifrac_pcoa_results.qza ⇒ unweighted-unifrac-111-emperor_plot.qzv
    • unweighted_unifrac_pcoa_results.qza ⇒ unweighted-unifrac-222-emperor_plot.qzv
  4. weighted UniFrac pcoa results : 
    • weighted_unifrac_pcoa_results.qza ⇒ weighted_unifrac-111-emperor_plot.qzv
    • weighted_unifrac_pcoa_results.qza ⇒ weighted_unifrac-222-emperor_plot.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 numicList file)
sbatch -A $projectID --mail-user=$email --export='projDir='$(pwd)'/,metaData='q2metadata.tsv',betaPcoaResultFile=jaccard_pcoa_results.qza' modules/QIIME2_Emperor.sh
 Further analysis the column in metadata (by user input)
sbatch -A $projectID --mail-user=$email --export='projDir='$(pwd)'/,metaData='q2metadata.tsv',betaPcoaResultFile=jaccard_pcoa_results.qza, columnName=111:222' modules/QIIME2_Emperor.sh
Usage(Linux console)Command in linux consoleFurther analysis the column in metadata (by numicList file)
bash modules/QIIME2_Emperor.sh -p $(pwd) -m q2metadata.tsv -b jaccard_pcoa_results.qza
 Further analysis the column in metadata (by user input)
bash modules/QIIME2_Emperor.sh -p $(pwd) -m q2metadata.tsv -b jaccard_pcoa_results.qza -c 111:222
#For Slurm operation, please refer to “Basic operation of Taiwania III“

Usage :

The following explains the usage of module parameters :

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

Leave a comment