Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing params to usage docs #255

Merged
merged 2 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- [#255](https://github.com/qbic-pipelines/rnadeseq/pull/255) Add usage docu for datasources, heatmaps_cluster_rows/cols and pathway_adj_pval_threshold params
- [#251](https://github.com/qbic-pipelines/rnadeseq/pull/251) Get raw gene count tables from either Salmon and RSEM analysis
- [#250](https://github.com/qbic-pipelines/rnadeseq/pull/250) Added clearer error message for incorrect contrast_pairs

Expand All @@ -33,6 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Removed

- [#247](https://github.com/qbic-pipelines/rnadeseq/pull/247) Removed hard-coded comment about usage of gprofiler databases KEGG and REAC in the report

## 2.3 - Flowering Orchards

### Added
Expand Down
20 changes: 20 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
- [`--vst_genes_number`](#--vst_genes_number)
- [`--round_DE`](#--round_DE)
- [`--run_pathway_analysis`](#--run_pathway_analysis)
- [`--pathway_adj_pval_threshold`](#--pathway_adj_pval_threshold)
- [`--heatmaps_cluster_rows`](#--heatmaps_cluster_rows)
- [`--heatmaps_cluster_cols`](#--heatmaps_cluster_cols)
- [`--input_type`](#--input_type)
- [`--multiqc`](#--multiqc)
- [`--project_summary`](#--project_summary)
Expand All @@ -48,6 +51,7 @@
- [`--custom_gmt`](#--custom_gmt)
- [`--set_background`](#--set_background)
- [`--custom_background`](#--custom_background)
- [`--datasources`](#--datasources)
- [`--igenomes_base`](#--igenomes_base)
- [`--igenomes_ignore`](#--igenomes_ignore)
- [Job resources](#job-resources)
Expand Down Expand Up @@ -373,6 +377,18 @@ Integer indicating to how many decimals to round the DE results (default: -1, in

Set this flag to run pathway analysis, otherwise, this step will be skipped.

### `--pathway_adj_pval_threshold`

Use this param to specifically set the adjusted p value threshold for pathway enrichment analysis (will otherwise use the same adjusted p value threshold as for the DE analysis, as set with the param `--adj_pval_threshold`).

### `--heatmaps_cluster_rows`

Use this flag to set whether the heatmaps of gene expression in enriched pathways should by clustered row-wise (default true).

### `--heatmaps_cluster_cols`

Use this flag to set whether the heatmaps of gene expression in enriched pathways should by clustered column-wise (default false).

### `--input_type`

This tells the pipeline which type of input dataset is provided. Must be one of 'featurecounts', 'rsem', 'salmon', 'smrnaseq', default: featurecounts.
Expand Down Expand Up @@ -450,6 +466,10 @@ Whether to restrict pathway analysis to a background gene list (default: true, w

Path to custom background TXT file with one gene ID per line to use as background genes, not necessary if `--run_pathway_analysis = false` or `--set_background = false`.

### `--datasources`

Which datasources to use for pathway analysis, comma-separated string like 'KEGG,REAC'. See param 'sources' on https://rdrr.io/cran/gprofiler2/man/gost.html for a list of available sources. If not set, will use all sources. If set while a --custom_gmt is provided, will filter the GMT for these datasources (will not filter for the GO subtypes like GO:BP, just for GO).

## Job resources

### Automatic resubmission
Expand Down
Loading