Templates with revision indicates that the components or processes have undergone comprehensive parameterization and testing.
Templates with revision indicates that the components or processes are currently being tested. There is some test data available, but there are parameters that need to be set up manually within the code.
Templates with revision indicates that the components or processes are not fully tested. There is no test data available, parameters need to be set up manually within the code, and specific code changes are required based on the data used.
These templates assume that the raw data has been processed by nf-core/rnaseq.
The nf-core/rnaseq
documentation describes a samplesheet.csv
. We recommend using this samplesheet.csv
as a metadata or coldata file when applicable. This CSV can contain additional columns of relevant information even if these columns are not required or used by nf-core/rnaseq
.
source(install_depedencies.R)
rmarkdown::render("QC.Rmd", quiet = TRUE
Install Pixi:
curl -fsSL https://pixi.sh/install.sh | sh
And then run_qc report, an HTML report should be inside the 01_quality_assessment
folder.
pixi run test_qc
Before using any template:
YAML
header of the Rmd
files to choose the right parameters for that report.Additional useful info:
params*example.R
are files containing parameters pointing to a small, simple dataset that can be used to test the report code and see how the fully rendered report looks.render.R
is an example of code to render a report while specifying parameters at the time of rendering. This can be used to render a report multiple times using multiple sets of parameters without duplicating the report code. 01_quality_assessment/QC.qmd is a report template that uses as input the
nf-core/rnaseq
outputs specified in 00_params/params.R. It also uses helper functions defined in 00_libs/load_data.R. This template examines:
On the YAML
header file of the qmd
you can specify some parameters or just set them up in the second chunk of code of the template.
02_differential_expression/DEG.Rmd is a report template for comparison between two groups. It supports multiple contrasts. Like 01_quality_assessment/QC.Rmd, it uses as input the
nf-core/rnaseq
outputs specified in 00_params/params.R. It also uses helper functions defined in 00_libs/load_data.R and 00_libs/FA.R.
On the YAML
header file of the Rmd
you can specify some parameters or just set them up in the second chunk of code of the template.
This template has examples of: