Option reference


usage: pyseer [-h] --phenotypes PHENOTYPES
           [--phenotype-column PHENOTYPE_COLUMN]
           (--kmers KMERS | --vcf VCF | --pres PRES) [--burden BURDEN]
           [--distances DISTANCES | --load-m LOAD_M]
           [--similarity SIMILARITY | --load-lmm LOAD_LMM]
           [--save-m SAVE_M] [--save-lmm SAVE_LMM]
           [--mds {classic,metric,non-metric}]
           [--max-dimensions MAX_DIMENSIONS] [--no-distances]
           [--continuous] [--lmm] [--enet] [--lineage]
           [--lineage-clusters LINEAGE_CLUSTERS]
           [--lineage-file LINEAGE_FILE] [--save-enet SAVE_ENET]
           [--load-enet LOAD_ENET] [--save-model SAVE_MODEL]
           [--alpha ALPHA] [--n-folds N_FOLDS] [--min-af MIN_AF]
           [--max-af MAX_AF] [--filter-pvalue FILTER_PVALUE]
           [--lrt-pvalue LRT_PVALUE] [--cor-filter COR_FILTER]
           [--covariates COVARIATES]
           [--use-covariates [USE_COVARIATES [USE_COVARIATES ...]]]
           [--print-samples] [--print-filtered]
           [--output-patterns OUTPUT_PATTERNS] [--uncompressed] [--cpu CPU]
           [--block_size BLOCK_SIZE] [--version]

SEER (doi: 10.1038/ncomms12797), reimplemented in python

Command line options

optional arguments:
-h, --help show this help message and exit
--phenotypes PHENOTYPES
 Phenotypes file
--phenotype-column PHENOTYPE_COLUMN
 Phenotype file column to use [Default: last column]
--kmers KMERS Kmers file
--vcf VCF VCF file. Will filter any non ‘PASS’ sites
--pres PRES Presence/absence .Rtab matrix as produced by roary and piggy
--burden BURDEN
 VCF regions to group variants by for burden testing (requires –vcf). Requires vcf to be indexed
--distances DISTANCES
 Strains distance square matrix (fixed or lineage effects)
--load-m LOAD_M
 Load an existing matrix decomposition
--similarity SIMILARITY
 Strains similarity square matrix (for –lmm)
--load-lmm LOAD_LMM
 Load an existing lmm cache
--save-m SAVE_M
 Prefix for saving matrix decomposition
--save-lmm SAVE_LMM
 Prefix for saving LMM cache
--mds Type of multidimensional scaling [Default: classic] {classic,metric,non-metric}
--max-dimensions MAX_DIMENSIONS
 Maximum number of dimensions to consider after MDS [Default: 10]
--no-distances Allow run without a distance matrix
Association options:
--continuous Force continuous phenotype [Default: binary auto- detect]
--lmm Use random instead of fixed effects to correct for population structure. Requires a similarity matrix
--enet Use an elastic net for association. Population structure correction is implicit.
--lineage Report lineage effects
--lineage-clusters LINEAGE_CLUSTERS
 Custom clusters to use as lineages [Default: MDS components]
--lineage-file LINEAGE_FILE
 File to write lineage association to [Default: lineage_effects.txt]
Elastic net options:
--save-enet SAVE_ENET
 Prefix for saving enet variants
--load-enet LOAD_ENET
 Prefix for loading enet variants
--save-model SAVE_MODEL
 Prefix for saving enet model
--alpha ALPHA Set the mixing between l1 and l2 penalties [Default: 0.0069]
--n-folds N_FOLDS
 Number of folds cross-validation to perform [Default: 10]
Filtering options:
--min-af MIN_AF
 Minimum AF [Default: 0.01]
--max-af MAX_AF
 Maximum AF [Default: 0.99]
--filter-pvalue FILTER_PVALUE
 Prefiltering t-test pvalue threshold [Default: 1]
--lrt-pvalue LRT_PVALUE
 Likelihood ratio test pvalue threshold [Default: 1]
--cor-filter COR_FILTER
 Correlation filter for elastic net [Default: 0.25]
--covariates COVARIATES
 User-defined covariates file (tab-delimited, no header, first column contains sample names)
--use-covariates USE_COVARIATES
 Covariates to use. Format is “2 3q 4” (q for quantitative) [Default: load covariates but don’t use them]
 Print sample lists [Default: hide samples]
 Print filtered variants (i.e. fitting errors) [Default: hide them]
--output-patterns OUTPUT_PATTERNS
 File to print patterns to, useful for finding pvalue threshold
--uncompressed Uncompressed kmers file [Default: gzipped]
--cpu CPU Processes [Default: 1]
--block_size BLOCK_SIZE
 Number of variants per core [Default: 3000]
--version show program’s version number and exit