Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ source("http://bioconductor.org/biocLite.R")
biocLite("IRanges","BSgenome.Hsapiens.UCSC.hg19")
```

####Usage:
#### Usage:
```
./hotspot_algo.R
--input-maf=[REQUIRED: mutation file]
Expand All @@ -42,7 +42,7 @@ Command to run hotspot algorithm on genes listed in file genes_of_interest.txt:
--output-file=sig_hotspots.txt
```

####Contents:
#### Contents:
**[ Required ]** `hotspot_algo.R` - R script to execute hotspot detection algorithm

**[ Required ]** `hotspot_algo.Rdata` - Rdata object with necessary files for algorithm (mutability, expression filters, etc)
Expand All @@ -53,7 +53,7 @@ Command to run hotspot algorithm on genes listed in file genes_of_interest.txt:

`minimalist_test_maf.txt` - minimalist MAF needed from maf2maf. [mskcc/maf2maf](https://github.com/mskcc/vcf2maf)

####Notes:
#### Notes:
`--align100mer` and `--align24mer` are optional filters based on how uniquely k-mer sequences align to a region of the hg19 genome. Note, both filters were used as part of this analysis. See more information at [ENCODE Mapability](http://genome.ucsc.edu/cgi-bin/hgFileUi?db=hg19&g=wgEncodeMapability).

The use of these filters will require downloading the 100-mer and 24-mer alignability tracks from UCSC that are not included here:
Expand Down