Skip to content

Commit 7c06e8f

Browse files
authored
Update README.md
1 parent f1c880d commit 7c06e8f

1 file changed

Lines changed: 37 additions & 2 deletions

File tree

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
A tool to check two different EingenStrat databses for shared individuals, and extract or remove individuals from an EigenStrat database.
33

44
```
5-
usage: EigenStratDatabaseTools.py (-i <Input file prefix>) (-c <input ind file> | -R | -E) [-L <SAMPLE LIST> | -S Ind [-S Ind2]] [-o <OUTPUT FILE PREFIX>]
5+
usage: eigenstrat_database_tools.py (-i <Input file prefix>) (-c <input ind file> | -R | -E) [-L <SAMPLE LIST> | -S Ind [-S Ind2]] [-o <OUTPUT FILE PREFIX>]
66
77
A tool to check two different EingenStrat databses for shared individuals, and
88
extract or remove individuals from an EigenStrat database.
@@ -17,6 +17,11 @@ Available options:
1717
The desired output file prefix. Three output files are
1818
created, <OUTPUT FILES PREFIX>.geno , <OUTPUT FILES
1919
PREFIX>.snp and <OUTPUT FILES PREFIX>.ind .
20+
-s <INPUT FILE SUFFIX>, --Suffix <INPUT FILE SUFFIX>
21+
The suffix (if any) that follows .geno/.snp/.ind in
22+
the input files. For example, specifying '-s .txt'
23+
will treat <INPUT PREFIX>.{geno,snp,ind}.txt as the
24+
desired input files.
2025
-C <INPUT FILE>, --Check <INPUT FILE>
2126
Check the -i .ind file and the second .ind file for
2227
duplicate individuals. Population assignment and/or
@@ -37,4 +42,34 @@ Available options:
3742
A samples to be Extracted (-E) or Removed (-R) from
3843
the database. Can be called multiple times. Required
3944
with -E or -R. Mutually exclusive with -L.
40-
```
45+
-v, --version Print the version and exit.
46+
47+
```
48+
---
49+
# Eigenstrat SNP Coverage
50+
A tool to calculate the numbered of covered and total reads for each individual in an EigenStrat dataset.
51+
```
52+
usage: eigenstrat_snp_coverage.py (-i <Input file prefix>) [-s <Input file suffix>] [-o <Output filepath>] [-j | --json]
53+
54+
A tool to check two different EingenStrat databses for shared individuals, and
55+
extract or remove individuals from an EigenStrat database.
56+
57+
Available options:
58+
-h, --help show this help message and exit
59+
-i <INPUT FILES PREFIX>, --Input <INPUT FILES PREFIX>
60+
The desired input file prefix. Input files are assumed
61+
to be <INPUT PREFIX>.geno, <INPUT PREFIX>.snp and
62+
<INPUT PREFIX>.ind .
63+
-s <INPUT FILE SUFFIX>, --Suffix <INPUT FILE SUFFIX>
64+
The suffix (if any) that follows .geno/.snp/.ind in
65+
the input files. For example, specifying '-s .txt'
66+
will treat <INPUT PREFIX>.{geno,snp,ind}.txt as the
67+
desired input files.
68+
-o <OUTPUT FILEPATH>, --Output <OUTPUT FILEPATH>
69+
The filepath where the output table should be saved.
70+
Omit to print to stdout.
71+
-j, --json Create additional json formatted output file named
72+
<OUTPUT FILE>.json . [Default: '<INPUT FILES
73+
PREFIX>_eigenstrat_coverage_mqc.json']
74+
-v, --version Print the version and exit.
75+
```

0 commit comments

Comments
 (0)