diff --git a/docs/content/parsnp/quickstart.rst b/docs/content/parsnp/quickstart.rst index 8a0cf52..7c2d1ff 100644 --- a/docs/content/parsnp/quickstart.rst +++ b/docs/content/parsnp/quickstart.rst @@ -48,14 +48,19 @@ Parsnp quick start for three example scenarios. With reference & genbank file:: - parsnp -g -d -p + parsnp -g -d -p -NOTE: Genbank files are currently expected to have GI numbers for indexing. This means custom Genbank files (not downloaded from NCBI) will not have annotations appear in Gingr, though the alignment should still work. The dependency on GIs is expected to change in future versions. +NOTE: + + 1. Genbank files are currently expected to have GI numbers for indexing. This means custom Genbank files (not downloaded from NCBI) will not have annotations appear in Gingr, though the alignment should still work. The dependency on GIs is expected to change in future versions. + 2. GenBank files can only be specific for the reference genome + 3. -g and -r are mutually exclusive; you can either provide a fasta file for your reference genome, or GenBank file, but not both. + 4. All non-reference genomes are captured with the -d parameter. These genomes *must* be in fasta format and located within the specified directory. With reference but without genbank file:: parsnp -r -d -p - + Autorecruit reference to a draft assembly:: parsnp -q -d -p @@ -67,7 +72,7 @@ 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 (default = None) + -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)