...
Code Block | ||
---|---|---|
| ||
mkdir -p $SCRATCH/byteclub/multiqc/01_fastq
cd $SCRATCH/byteclub/multiqc/01_fastq
ln -s -f /work/01063/abattenh/projects/byteclub/multiqc/fastqc
ln -s -f $SCRATCH ~/scratch |
Now this is all it takes to produce a basic MultiQC report:
...
Expand | |||||
---|---|---|---|---|---|
| |||||
To view the file you created in a web browser, it must be copied somwhere where a browser can open it. An easy way to do this is to copy it to your laptop like this, for example, changing the user name from abattenh and scratch path as appropriate.
|
Add a few customizations
MultiQC reports can be customized by creating a file called multiqc_config.yaml in the directory where you call multiqc.
Use your favorite text editor to create a a file called multiqc_config.yaml in your $SCRATCH/byteclub/multiqc/01_fastq directory as shown below. This will add report title lines and change the names of the MultiQC output files.
Code Block | ||
---|---|---|
| ||
# Titles to use for the report. title: "ATAC-Seq QC Reports" subtitle: null intro_text: "MultiQC reports for Igor's ATAC-Seq proof-of-concept project." report_header_info: - Sequenced by: 'GSAF' - Job: 'JA17277' - Run: 'SA17121' - Setup: '2x150' # Change the output filenames output_fn_name: mqc_report.html data_dir_name: mqc_report_data |
After saving this file, remove the previous MultiQC outputs and re-run the program:
Code Block | ||
---|---|---|
| ||
cd $SCRATCH/byteclub/multiqc/01_fastq
rm -rf multiqc_data multiqc_report.html
multiqc . |
If all went well, you should now see a mqc_report.html file and a mqc_report_data directory. Your newly-generated mqc_report.html report file in should look like this (note the new title and header):
Tips for working with the MultiQC configuation file
Here are a few tips for working with the MultiQC configuration file.
- Always use spaces (not tabs!) in the multiqc_config.yaml file.
- Make sure the file is saved with Unix line endings (not Windows or Mac).
- Pay attention to the output when running multiqc. It will tell you if there are issues parsing the config file.
- Always delete any previous MultiQC output files before running multiqc
- While their documentation says existing files will just be updated, I have seen MultiQC get confused when previous reports exist.
- It is a good idea to change the name of the MultiQC output files
- If output files with those names are not created, something went wrong!
- Consult example config files
- An example multiqc_config.yaml file: https://github.com/ewels/MultiQC/blob/master/multiqc_config_example.yaml
- All multiqc_config.yaml defaults: https://github.com/ewels/MultiQC/blob/master/multiqc/utils/config_defaults.yaml
Add reports from a bowtie2 alignment
First stage some mm10 bowtie2 alignment data:
xx
Code Block | ||
---|---|---|
| ||
code |
...