Skip to content

Commit 3d218d5

Browse files
committed
Updated the docs to match the new options.
1 parent 33b6e54 commit 3d218d5

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/usage.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,17 @@ This section describes how to use *Structure_threader*.
33

44
These are the arguments the program currently takes:
55

6-
* K (-K)
7-
* Replicates (ignored for fastStructure; -R)
86
* Input file (-i)
97
* Output dir (-o)
8+
* Number of K
9+
* K (To test all values of "K" from 1 to "K"; -K)
10+
* K-list (To test all values of "K" in the provided list; -K-list)
11+
* Replicates (ignored for fastStructure; -R)
1012
* Number of threads (-t)
1113
* Program location - you have to pass one and only of the following arguments:
1214
* Structure location (if you want to run "structure"; -st)
1315
* fastStructure location (if you want to run "fastStructure"; -fs)
1416
* Logging (optional - useful when problems arise; --log)
15-
* Minimum K (optional - use as a start value for "K" - by default the value is 1; --min_K)
1617
* No-tests (optional - use this if you do not want to run the BestK tests; --no-tests)
1718
* No-plots (optional - use this if you do not want to draw plots; --no-plots)
1819
* Popfile (optional - use this if you want to name your populations in the plot. Should be a text file with 3 columns, one for population name, one for number of individuals represented in that population and one for the population position in the input file. This effectively allows the plot to be drawn in any chosen order.)

0 commit comments

Comments
 (0)