DOC_ID : T15-0002

QC_Multiqc module :

DOC_ID : M02-3000
Editor : Mira
Reviewer : Anita

Function :

彙整常見生物資訊分析工具的分析結果，及其分析過程紀錄檔，輸出輸出可獨立存取之HTML客製化報告檔案。可以根據使用者的整體分析工作流程，放置於任何一個步驟進行使用。

All software are included in GA environment.

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

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

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

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

Tested environment	GApp0.0.0.2
Software version	multiqc=1.9
Usage(Slurm)	Command in Slurm (Taiwania III) `sbatch -A $projectID --mail-user=$email --export='projDir='$(pwd)'/,qcDir=QC/,rptDir=report/,rptName=Case1' modules/QC_Multiqc.sh`
Usage(Linux console)	Command in linux console `bash modules/QC_Multiqc.sh -p $(pwd) -f QC/ -o report/ -s Case1`
#For Slurm operation, please refer to “Basic operation of Taiwania III“

The following explains the usage of module parameters :

Parameter	Description	Remark
QC_Multiqc.sh	MultiQC searches a given directory for analysis logs and compiles a HTML report. It’s a general use tool, perfect for summarising the output from numerous bioinformatics tools.	分析的模組需存放在[modules]資料夾中
projDir	分析專案的資料夾路徑（專案資料夾結構說明）	Script需在分析專案的資料夾執行， $(pwd) 會傳回使用者現在所在的路徑
qcDir	欲進行QC資料彙總的資料夾名稱 : 資料格式 : .json 或 .STARLog.final.out 或 .rnabamqc或.dnabamqc資料路徑 : QC/►若未設定此參數，預設資料夾為QC/	例如: qcDir=QC/會讀取在 QC/資料夾內所有檔名符合.json 或 .STARLog.final.out 或 .rnabamqc或.dnabamqc的資料
rptDir	輸出 QC 報告的資料夾名稱 :資料路徑: report/►若未設定此參數，預設資料夾為report/	例如: rptDir=report/會將生成的結果存放在 report/資料夾
rptName	輸出 QC 報告的檔案名稱 :資料格式 : .html 及 _data的資料夾	例如:rptName=Case1 會在report/資料夾生成名為Case1的html file及一個相對應資料夾 :1. Case1.html 2. Case1_data