Skip to content

Commit d2a4c1b

Browse files
committed
change BED to TSV
1 parent d998f8e commit d2a4c1b

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ VisualMSI can run in tumor-normal paired mode or case-only mode, and the tumor-n
1414
# A quick example
1515
* Tumor-normal paired mode:
1616
```shell
17-
visualmsi -i tumor.sorted.bam -n normal.sorted.bam -r hg19.fasta -t targets/msi.bed
17+
visualmsi -i tumor.sorted.bam -n normal.sorted.bam -r hg19.fasta -t targets/msi.tsv
1818
```
1919
* Case-only mode (no paired normal data given):
2020
```shell
21-
visualmsi -i tumor.sorted.bam -r hg19.fasta -t targets/msi.bed
21+
visualmsi -i tumor.sorted.bam -r hg19.fasta -t targets/msi.tsv
2222
```
2323

2424
# Get visualmsi program
@@ -57,7 +57,7 @@ The reference genome should be a single whole FASTA file containg all chromosome
5757
* `hg38/GRch38`: http://hgdownload.cse.ucsc.edu/goldenPath/hg38/bigZips/hg38.fa.gz Remember to decompress hg38.fa.gz since it is gzipped and is not supported currently.
5858

5959
## Target file
60-
The target file is a bed file giving the MSI locuses. To add a MSI target locus at `chr:position`, you can add a row with values (chrom, position, name). You can see the example from targets/msi.bed:
60+
The target file is a TSV (tab-separated values) file giving the MSI locuses. To add a MSI target locus at `chr:position`, you can add a row with values (chrom, position, name). You can see the example from targets/msi.tsv:
6161
```TSV
6262
#CHROM POSITION NAME
6363
chr4 55598216 BAT25
@@ -66,7 +66,7 @@ chr14 23652365 NR-21
6666
chr11 102193518 NR-27
6767
chr2 95849372 NR-24
6868
```
69-
Please note that this bed file is based on hg19 coordination.
69+
Please note that this file is based on hg19 coordination.
7070

7171
# Reports
7272
VisualMSI reports results in HTML/JSON/TEXT formats, you can take a look at following examples:
@@ -91,7 +91,7 @@ VisualMSI reports results in HTML/JSON/TEXT formats, you can take a look at foll
9191
options:
9292
-i, --in input sorted bam/sam file for the case (tumor) sample. STDIN will be read from if it's not specified (string [=-])
9393
-n, --normal input sorted bam/sam file for the paired normal sample (tumor-normal mode). If not specified, VisualMSI will run in case-only mode. (string [=])
94-
-t, --target the bed file (chr, start, end, name) to give the MSI targets (string)
94+
-t, --target the TSV file (chr, start, end, name) to give the MSI targets (string)
9595
-r, --ref reference fasta file name (should be an uncompressed .fa/.fasta file) (string)
9696
9797
# options for setting thresholds

src/main.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ int main(int argc, char* argv[]){
3030
// input/output
3131
cmd.add<string>("in", 'i', "input sorted bam/sam file for the case (tumor) sample. STDIN will be read from if it's not specified", false, "-");
3232
cmd.add<string>("normal", 'n', "input sorted bam/sam file for the paired normal sample (tumor-normal mode). If not specified, VisualMSI will run in case-only mode.", false, "");
33-
cmd.add<string>("target", 't', "the bed file (chr, start, end, name) to give the MSI targets", true, "");
33+
cmd.add<string>("target", 't', "the TSV file (chrom, position, name) to give the MSI targets", true, "");
3434
cmd.add<string>("ref", 'r', "reference fasta file name (should be an uncompressed .fa/.fasta file)", true, "");
3535

3636
// UMI
File renamed without changes.

0 commit comments

Comments
 (0)