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: README.md
+7-8Lines changed: 7 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,18 @@
1
1
# Cyrius: WGS-based CYP2D6 genotyper
2
-
Cyrius is a tool to genotype CYP2D6 from a whole-genome sequencing (WGS) BAM file. Cyrius uses a novel method to solve the problems caused by the high sequence similarity with the pseudogene paralog CYP2D7 and thus is able to detect all star alleles, particularly those that contain structural variants, accurately. Please refer to our [preprint](https://www.biorxiv.org/content/10.1101/2020.05.05.077966v1) for details about the method.
2
+
Cyrius is a tool to genotype CYP2D6 from a whole-genome sequencing (WGS) BAM file. Cyrius uses a novel method to solve the problems caused by the high sequence similarity with the pseudogene paralog CYP2D7 and thus is able to detect all star alleles, particularly those that contain structural variants, accurately. Please refer to our [preprint](https://www.biorxiv.org/content/10.1101/2020.05.05.077966v2) for details about the method.
3
3
4
4
## Running the program
5
5
6
6
This Python3 program can be run as follows:
7
7
```bash
8
-
star_caller.py --manifest MANIFEST_FILE \
9
-
--genome [19/37/38] \
10
-
--prefix OUTPUT_FILE_PREFIX \
11
-
--outDir OUTPUT_DIRECTORY \
12
-
--threads NUMBER_THREADS
8
+
python3 star_caller.py --manifest MANIFEST_FILE \
9
+
--genome [19/37/38] \
10
+
--prefix OUTPUT_FILE_PREFIX \
11
+
--outDir OUTPUT_DIRECTORY \
12
+
--threads NUMBER_THREADS
13
13
```
14
14
The manifest is a text file in which each line should list the absolute path to an input BAM/CRAM file.
15
-
For CRAM input, it’s suggested to provide the path to the reference fasta file with `--reference` in the command.
16
-
Additionally, there is an option `--knownFunction` to call only star alleles with known functions, as well as an option `--includeNewStar` to call all star alleles including the newly added, uncurated ones (\*115-\*139) in PharmVar.
15
+
For CRAM input, it’s suggested to provide the path to the reference fasta file with `--reference` in the command.
0 commit comments