-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,8 @@ | ||
# SuperNovo | ||
|
||
SuperNovo is a utility for identifying and validating De Novo Mutations in Next Generation Sequencing data. It's current functionality is to generate a file of metrics for De Novo SNPs and Indels from a VCF/BCF of variants and SAM/BAM/CRAMs for a child and parents. In the future, it will be able to operate without the VCF/BCF of variants and perform de novo variant calling. | ||
SuperNovo is a utility for identifying and validating De Novo Mutations in Next Generation Sequencing data. It's current functionality is to generate a file of metrics for De Novo SNPs from a VCF/BCF of variants and SAM/BAM/CRAMs for a child and parents. | ||
|
||
This project is very much still in progress and should be considered an alpha release. | ||
## Getting Started | ||
|
||
1. Download a .jar from the [releases page](https://github.com/PankratzLab/SuperNovo/releases) | ||
2. Run `java -jar supernovo.jar` (replacing `supernovo.jar` with the version you downloaded) to get the help text which details the required parameters and a number of optional parameters to override default thresholds and behavior. |