Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
admire/docs/parameters.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
29 lines (26 sloc)
1.51 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Here we list all current parameters for command-line usage and their explanation: | |
``` | |
Usage: admire [options] | |
Available options: | |
-c | Comma separated sample definition file (SampleSheet.csv) | |
-s | Tab separated sample definition file (design.txt) | |
-z | Compressed input of idat files (requires -c). | |
-e | Create quality control report in PDF | |
-r | Region file in bed format (regions.bed), use multiple -r parameters to calculate for multiple region files | |
-p | Detection p-value to exclude probes prior to analysis (0.01) | |
-t | Exclude probes where more than t% samples failed according to the detection p-value. (0.4) | |
-n | Normalization method (fn,swan,noob,illumina,raw,quantile) | |
-b | In case of functional normalization, skip noob background correction step | |
-d | In case of noob or functional normalization, skip dye correction step | |
-f | In case of quantile normalization, skip fixing outliers prior to analysis | |
-l | In case of quantile normalization, label samples as bad if their median signals are below a given value (10.5) | |
-m | In case of quantile normalization, remove bad samples | |
-q | Q-value cutoff for multiple testing correction (0.05) | |
-i | Render advanced plots for the best i regions (20) | |
-g | Gene set file for enrichment analysis, use multiple -g parameters to calculate enrichment over many gene sets | |
-o | tar-gz compress output into file given | |
-a | Dry-run; Writes all necessary config files, but does not compute anything | |
-h | shows this help message | |
-v | shows version information | |
Options -c and -s are mutually exclusive. | |
``` |