Skip to content

Commit 390cdcd

Browse files
committed
Updated the docs to mention Plink format too.
1 parent 3318131 commit 390cdcd

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

docs/usage.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,22 @@ You can use any order you like using this scheme. Also note that the "split bars
5454

5555

5656
## fastStrucutre Warning:
57-
If running fastStructure, keep in mind that this program requires your input
58-
file to have each individual represented in two rows (one for each allele), and
59-
six "bogus" columns before the actual data. **No Header is allowed**. Here is a short example:
57+
Keep in mind that fastStructure can take input in two distinct file formats:
58+
[Plink](http://pngu.mgh.harvard.edu/%7Epurcell/plink/data.shtml) and
59+
[structure](http://pritchardlab.stanford.edu/software/structure-data_v.2.3.1.html).
60+
In order to use the PLINK format, three files are required:
61+
62+
* `file.bed`
63+
* `file.fam`
64+
* `file.bim`
65+
66+
You can enter any of them (but just one oof them) as the input file and
67+
*Structure_threader* will assume the other two exist in the same path.
68+
If the input file specified by the *-i* switch in *Structure_threader* has an
69+
extension different from either of the three mentioned above, *Structure_threader* will assume th input is in the STRUCTURE format, which has some peculiarities:
70+
fastStructure requires your input file to have each individual represented in
71+
two rows (one for each allele), and six "bogus" columns before the actual data.
72+
**No Header is allowed**. Here is a short example:
6073

6174
```
6275
Ind1 col1 col2 col3 col4 col5 1 3 1 4
@@ -66,4 +79,4 @@ Ind2 col1 col2 col3 col4 col5 1 2 1 3
6679
6780
```
6881

69-
Don't forget to look at the [Outputs section](output.md) for information on how the data is presented after a successful (or not) run.
82+
Don't forget to look at the [Output section](output.md) for information on how the data is presented after a successful (or not) run.

0 commit comments

Comments
 (0)