Skip to content

Commit 982ac75

Browse files
committed
Updated the docs for the new arguments.
1 parent cd99f06 commit 982ac75

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

docs/usage.md

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

44
These are the arguments the program currently takes:
55

6-
* Input file (-i)
7-
* Output directory (-o)
6+
* I/O arguments:
7+
* Input file (-i)
8+
* Output directory (-o)
9+
* Path to parameters_file (--params)
10+
* Individual/Population identification options:
11+
* Path to popfile (--pop) [See below for more information]
12+
* Path to indfile (--ind) [See below for more information]
13+
* Extrnal program location - you have to pass one and only one of the following arguments:
14+
* *STRUCTURE* location (if you want to run *STRUCTURE*; -st)
15+
* *fastStructure* location (if you want to run *fastStructure*; -fs)
16+
* *MavericK* location (if you want to run *MavericK*; -mv)
817
* Number of K - you have to pass one and only one of the following arguments:
918
* K (To test all values of "K" from 1 to "K"; -K)
1019
* Klist (To test all values of "K" in the provided list; -Klist)
1120
* Replicates (ignored for *fastStructure* and *MavericK*; -R)
12-
* Number of threads (-t)
13-
* Program location - you have to pass one and only one of the following arguments:
14-
* *STRUCTURE* location (if you want to run *STRUCTURE*; -st)
15-
* *fastStructure* location (if you want to run *fastStructure*; -fs)
16-
* *MavericK* location (if you want to run *MavericK*; -mv)
17-
* Logging (optional - useful when problems arise; --log)
18-
* No-tests (optional - use this if you do not want to run the BestK tests; --no-tests)
19-
* No-plots (optional - use this if you do not want to draw plots; --no-plots)
20-
* 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.)
21+
* Number of threads to use (-t)
22+
* Q-matrix plotting options:
23+
* Disable plot drawing (--no_plots)
24+
* Just draw the plots, do not run any wrapped programs. Requires a previously finished run (--just_plots)
25+
* Override 'K' values from the given list to be plotted in the combined figure (--override_bestk '2 4 5')
26+
* Other options
27+
* Enable logging - useful when problems arise (--log)
28+
* Do not run the BestK tests (--no-tests)
29+
* Add extra arguments to pass to the wrapped program (--extra_opts) [Example: prior=logistic seed=123]
30+
2131

2232
Example run:
2333

0 commit comments

Comments
 (0)