Skip to content

Commit 0b4b0aa

Browse files
author
Joe Brown
committed
updates readme
1 parent fc4fca0 commit 0b4b0aa

1 file changed

Lines changed: 4 additions & 9 deletions

File tree

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,8 @@ points.
1616

1717
# The Python Package
1818

19-
`covviz` is installable via `pip install -U covviz`. It's currently quite
20-
dependent upon `indexcov` output, but we're working to make this more
21-
generalized -- to accept any bed input, normalize the coverage, and calculate
22-
the ROC curves.
19+
`covviz` is installable via `pip install -U covviz` and analyzes a bed3+
20+
output format.
2321

2422
## Usage
2523

@@ -34,7 +32,7 @@ for samples test_sample1, test_sample2, and test_sample3, this would look like:
3432
Then CLI usage is:
3533

3634
```
37-
covviz --ped $ped $bed $roc
35+
covviz $bed
3836
```
3937

4038
### Custom Metadata (.ped)
@@ -44,7 +42,7 @@ the default column IDs pertaining to the column which contains the sample ID
4442
and the sex of the sample.
4543

4644
```
47-
covviz --ped $ped --sample-col sample_col --sex sex_col $bed $roc
45+
covviz --ped $ped --sample-col sample_col --sex sex_col $bed
4846
```
4947

5048
# The Nextflow Workflow
@@ -114,9 +112,6 @@ Which gives us `./results/covviz_report.html`.
114112
+ `--slop`
115113
+ leading and trailing segments added to significant regions to make them more visible
116114
+ default: 500000
117-
+ `--project`
118-
+ can be used to name your indexcov to something more meaningful
119-
+ default: "NF"
120115
+ `--ped`
121116
+ custom metadata that will be merged with the .ped output of indexcov
122117
+ default: false

0 commit comments

Comments
 (0)