Fix the -T argument in the DepthOfCoverage docs
Add documentation for the RefSeqCodec, pointing users to the wiki page describing how to create the file
This commit is contained in:
parent
33967a4e0c
commit
8143def292
|
|
@ -63,9 +63,12 @@ import java.util.*;
|
|||
* <h2>Input</h2>
|
||||
* <p>
|
||||
* One or more bam files (with proper headers) to be analyzed for coverage statistics
|
||||
* (Optional) A REFSEQ Rod to aggregate coverage to the gene level
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
*(Optional) A REFSEQ Rod to aggregate coverage to the gene level
|
||||
* <p>
|
||||
* (for information about creating the REFSEQ Rod, please consult the RefSeqCodec documentation)
|
||||
*</p></p>
|
||||
* <h2>Output</h2>
|
||||
* <p>
|
||||
* Tables pertaining to different coverage summaries. Suffix on the table files declares the contents:
|
||||
|
|
@ -93,7 +96,7 @@ import java.util.*;
|
|||
* <pre>
|
||||
* java -Xmx2g -jar GenomeAnalysisTK.jar \
|
||||
* -R ref.fasta \
|
||||
* -T VariantEval \
|
||||
* -T DepthOfCoverage \
|
||||
* -o file_name_base \
|
||||
* -I input_bams.list
|
||||
* [-geneList refSeq.sorted.txt] \
|
||||
|
|
|
|||
|
|
@ -12,19 +12,35 @@ import org.broadinstitute.sting.utils.exceptions.UserException;
|
|||
import java.util.ArrayList;
|
||||
|
||||
/**
|
||||
* TODO FOR CHRIS HARTL
|
||||
* Allows for reading in RefSeq information
|
||||
*
|
||||
* <p>
|
||||
* Codec Description
|
||||
* Parses a sorted UCSC RefSeq file (see below) into relevant features: the gene name, the unique gene name (if multiple transcrips get separate entries), exons, gene start/stop, coding start/stop,
|
||||
* strandedness of transcription.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* See also: link to file specification
|
||||
* Instructions for generating a RefSeq file for use with the RefSeq codec can be found on the Wiki here
|
||||
* <a href="http://www.broadinstitute.org/gsa/wiki/index.php/RefSeq">http://www.broadinstitute.org/gsa/wiki/index.php/RefSeq</a>
|
||||
* </p>
|
||||
* <h2> Usage </h2>
|
||||
* The RefSeq Rod can be bound as any other rod, and is specified by REFSEQ, for example
|
||||
* <pre>
|
||||
* -refSeqBinding:REFSEQ /path/to/refSeq.txt
|
||||
* </pre>
|
||||
*
|
||||
* You will need to consult individual walkers for the binding name ("refSeqBinding", above)
|
||||
*
|
||||
* <h2>File format example</h2>
|
||||
* If you want to define your own file for use, the format is (tab delimited):
|
||||
* bin, name, chrom, strand, transcription start, transcription end, coding start, coding end, num exons, exon starts, exon ends, id, alt. name, coding start status (complete/incomplete), coding end status (complete,incomplete)
|
||||
* and exon frames, for example:
|
||||
* <pre>
|
||||
* 76 NM_001011874 1 - 3204562 3661579 3206102 3661429 3 3204562,3411782,3660632, 3207049,3411982,3661579, 0 Xkr4 cmpl cmpl 1,2,0,
|
||||
* </pre>
|
||||
* for more information see <a href="http://skip.ucsc.edu/cgi-bin/hgTables?hgsid=5651&hgta_doSchemaDb=mm8&hgta_doSchemaTable=refGene">here</a>
|
||||
* <p>
|
||||
* A BAM file containing <b>exactly one sample</b>.
|
||||
*
|
||||
* </p>
|
||||
*
|
||||
* @author Mark DePristo
|
||||
|
|
|
|||
Loading…
Reference in New Issue