diff --git a/docs/content/parsnp/quickstart.rst b/docs/content/parsnp/quickstart.rst index 7c2d1ff..5b775fe 100644 --- a/docs/content/parsnp/quickstart.rst +++ b/docs/content/parsnp/quickstart.rst @@ -25,14 +25,14 @@ Parsnp is distributed as a precompiled binary that should be devoid of external On OSX: """"""" - 1. wget https://github.com/marbl/parsnp/releases/download/v1.0/parsnp-OSX64-v1.0.tar.gz - 2. tar -xvf parsnp-OSX64-v1.0.tar.gz + 1. wget https://github.com/marbl/parsnp/releases/download/v1.1/parsnp-OSX64-v1.1.tar.gz + 2. tar -xvf parsnp-OSX64-v1.1.tar.gz On Linux: """"""""" - 1. wget https://github.com/marbl/parsnp/releases/download/v1.0/parsnp-Linux64-v1.0.tar.gz - 2. tar -xvf parsnp-Linux64-v1.0.tar.gz + 1. wget https://github.com/marbl/parsnp/releases/download/v1.1/parsnp-Linux64-v1.1.tar.gz + 2. tar -xvf parsnp-Linux64-v1.1.tar.gz Basic usage: """""""""""" @@ -70,41 +70,45 @@ Command-line parameters: Input/output:: - -c = : (c)urated genome directory, use all genomes in dir and ignore MUMi? (default = NO) - -d = : (d)irectory containing genomes/contigs/scaffolds - -g = : Gen(b)ank file(s) (gbk), comma separated list for each replicon (default = None) - -o = : output directory? default [./P_CURRDATE_CURRTIME] - -q = : (optional) specify (assembled) query genome to use, in addition to genomes found in genome dir (default = NONE) - -r = : (r)eference genome (set to ! to pick random one from genome dir) + -c = : (c)urated genome directory, use all genomes in dir and ignore MUMi? (default = NO) + -d = : (d)irectory containing genomes/contigs/scaffolds + -r = : (r)eference genome (set to ! to pick random one from genome dir) + -g = : Gen(b)ank file(s) (gbk), comma separated list (default = None) + -o = : output directory? default [./P_CURRDATE_CURRTIME] + -q = : (optional) specify (assembled) query genome to use, in addition to genomes found in genome dir (default = NONE) + MUMi:: - -M = : calculate MUMi and exit? overrides all other choices! (default: NO) - -U = : max (M)UMi distance (default: autocutoff based on distribution of MUMi values) + -U = : max MUMi distance value for MUMi distribution + -M = : calculate MUMi and exit? overrides all other choices! (default: NO) + -i = : max MUM(i) distance (default: autocutoff based on distribution of MUMi values) MUM search:: - -a = : min (a)NCHOR length (default = 1.1*Log(S)) - -C = : maximal cluster D value? (default=100) - -z = : min LCB si(z)e? (default = 25) + -a = : min (a)NCHOR length (default = 1.1*Log(S)) + -C = : maximal cluster D value? (default=100) + -z = : min LCB si(z)e? (default = 25) LCB alignment:: - -D = : maximal diagonal difference? Either percentage (e.g. 0.2) or bp (e.g. 100bp) (default = 0.12) - -e = greedily extend LCBs? experimental! (default = NO) - -n = : alignment program (default: libMUSCLE) + -D = : maximal diagonal difference? Either percentage (e.g. 0.2) or bp (e.g. 100bp) (default = 0.12) + -e = greedily extend LCBs? experimental! (default = NO) + -n = : alignment program (default: libMUSCLE) + -u = : output unaligned regions? .unaligned (default: NO) SNP filters:: - -R = : disable (R)epeat filtering? - -x = : enable recombination filtering? (default: NO) + -R = : enable (R)epeat filtering? + -x = : enable recombination filtering? (default: NO) Misc:: - -h = : (h)elp: print this message - -P = : max partition size? limits memory usage (default= 15000000) - -p = : number of threads to use? (default= 1) - -v = : (v)erbose output? (default = NO) + -h = : (h)elp: print this message and exit + -p = : number of threads to use? (default= 1) + -P = : max partition size? limits memory usage (default= 15000000) + -v = : (v)erbose output? (default = NO) + -V = : output (V)ersion and exit Output Files -------------