You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage.md
+32-5Lines changed: 32 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,14 @@
1
1
# Usage
2
2
This section describes how to use *Structure_threader*.
3
3
4
-
These are the arguments the program currently takes:
4
+
*Structure_threader* can be executed via two main modes.
5
+
6
+
-`run`: The main execution mode that performs the parallel execution of the external structuring program, calculates the best K values and generates the plot files
7
+
-`plot`: This execution mode will only generate new plot files from the output files of the structuring program.
8
+
9
+
### `run` mode
10
+
11
+
Using the `run` mode, the program currently takes the following arguments:
5
12
6
13
* I/O arguments:
7
14
* Input file (-i)
@@ -20,9 +27,7 @@ These are the arguments the program currently takes:
20
27
* Replicates (ignored for *fastStructure* and *MavericK*; -R)
21
28
* Number of threads to use (-t)
22
29
* 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')
30
+
* Disable plot drawing (--no_plots)
26
31
* Other options
27
32
* Enable logging - useful when problems arise (--log)
28
33
* Do not run the BestK tests (--no-tests)
@@ -32,7 +37,7 @@ These are the arguments the program currently takes:
Where -K is the number of "Ks" to run, -R is the number of replicate runs for
@@ -42,6 +47,28 @@ each value of "K", -i is the input file for *STRUCTURE*, -o is the directory whe
42
47
The program should be run in the same directory where the files "mainparams" and
43
48
"extraparams" for your *STRUCTURE* run are placed. Please see [Installation](install.md) for information on how to achieve this.
44
49
50
+
### `plot` mode
51
+
52
+
Using the `plot` mode, the program currently takes the following arguments:
53
+
54
+
* Main plotting options:
55
+
* Prefix of the structuring software output files (-i)
56
+
* External program or format of the output files. This can be 'structure', 'fastStructure' or 'maverick'. (-f)
57
+
* The K values that you want to plot. Each individual K value that is provided will be plotted individually and in the end, a comparative plot will all K values will also be generated. (-K; Example: -K 2 3 4)
58
+
59
+
* Directory where the plots will be generated. By default they will be generated in the current working directory (-o)
60
+
61
+
* Individual/Population identification options:
62
+
* Path to popfile (--pop) [See below for more information]
63
+
* Path to indfile (--ind) [See below for more information]
Here, *Structure_threader* will search the current directory for all FastStructure output files that start with the "fS_run" string, as specified by the "-i" option. The "-f" option specified the fastStructure format of the output files. The "-K" option specified which K values should be plotted (Note: If any of the provided K values do not exist, they are ignored). Using the "-o" option the plots will be generated into the "2_4_plots" directory. Finally, we also provide an "indfile" using the "--ind" option.
45
72
46
73
## Using a "popfile"
47
74
*Structure_threader* can build your structure plots with labels and in a specified order. For that you have to provide a "popfile" (--pop option). This file consists of the following 3 columns: "Population name", "Number of individuals in the population", "Order of the population in the plot file".
0 commit comments