A succint walker that reports GC content by interval. Taking down two old implementations of the same thing from oneoffs. Documentation added to the wiki.

git-svn-id: file:///humgen/gsa-scr1/gsa-engineering/svn_contents/trunk@5790 348d0f76-0448-11de-a6fe-93d51630548a
This commit is contained in:
carneiro 2011-05-11 18:53:11 +00:00
parent 9a1d0d7076
commit fb1be2653c
3 changed files with 86 additions and 205 deletions

View File

@ -0,0 +1,86 @@
/*
* Copyright (c) 2011, The Broad Institute
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
package org.broadinstitute.sting.gatk.walkers;
import org.broadinstitute.sting.commandline.Output;
import org.broadinstitute.sting.gatk.contexts.AlignmentContext;
import org.broadinstitute.sting.gatk.contexts.ReferenceContext;
import org.broadinstitute.sting.gatk.refdata.RefMetaDataTracker;
import org.broadinstitute.sting.gatk.walkers.*;
import org.broadinstitute.sting.utils.BaseUtils;
import org.broadinstitute.sting.utils.GenomeLoc;
import org.broadinstitute.sting.utils.collections.Pair;
import java.io.PrintStream;
import java.util.*;
/**
* Walks along reference and calculates the GC content for each interval.
*/
@Allows(value = {DataSource.REFERENCE})
@Requires(value = {DataSource.REFERENCE})
@By(DataSource.REFERENCE)
public class GCContentByIntervalWalker extends LocusWalker<Long, Long> {
@Output
protected PrintStream out;
public boolean isReduceByInterval() {
return true;
}
public void initialize() {
}
public boolean generateExtendedEvents() {
return false;
}
public Long reduceInit() {
return 0L;
}
public Long map(RefMetaDataTracker tracker, ReferenceContext ref, AlignmentContext context) {
if (tracker == null)
return null;
int baseIndex = ref.getBaseIndex();
return (baseIndex == BaseUtils.gIndex || baseIndex == BaseUtils.cIndex) ? 1L : 0L;
}
public Long reduce(Long toAdd, Long runningCount) {
return runningCount + toAdd;
}
public void onTraversalDone(List<Pair<GenomeLoc, Long>> results) {
for (Pair<GenomeLoc, Long> result : results ) {
GenomeLoc loc = result.getFirst();
Long gcCount = result.getSecond();
double gcContent = (double) gcCount / loc.size();
out.println(loc + "\t" + gcContent);
}
}
}

View File

@ -1,134 +0,0 @@
/*
* Copyright (c) 2010, The Broad Institute
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
package org.broadinstitute.sting.oneoffprojects.walkers.CNV;
import org.broadinstitute.sting.commandline.Output;
import org.broadinstitute.sting.gatk.contexts.AlignmentContext;
import org.broadinstitute.sting.gatk.contexts.ReferenceContext;
import org.broadinstitute.sting.gatk.refdata.RefMetaDataTracker;
import org.broadinstitute.sting.gatk.refdata.ReferenceOrderedDatum;
import org.broadinstitute.sting.gatk.refdata.utils.GATKFeature;
import org.broadinstitute.sting.gatk.walkers.*;
import org.broadinstitute.sting.utils.BaseUtils;
import org.broadinstitute.sting.utils.GenomeLoc;
import org.broadinstitute.sting.utils.collections.Pair;
import org.broadinstitute.sting.utils.exceptions.UserException;
import java.io.PrintStream;
import java.util.*;
/**
* Walks along reference and calculates the GC content for each interval.
*/
@Allows(value = {DataSource.REFERENCE})
@Requires(value = {DataSource.REFERENCE})
@By(DataSource.REFERENCE)
public class GCcontentIntervalWalker extends LocusWalker<GCcounter, GCcounter> {
@Output
protected PrintStream out;
public boolean isReduceByInterval() {
return true;
}
public void initialize() {
}
public boolean generateExtendedEvents() {
return false;
}
public GCcounter reduceInit() {
return new GCcounter();
}
/**
* @param tracker the meta-data tracker
* @param ref the reference base
* @param context the context for the given locus
* @return statistics of and list of all phased VariantContexts and their base pileup that have gone out of cacheWindow range.
*/
public GCcounter map(RefMetaDataTracker tracker, ReferenceContext ref, AlignmentContext context) {
if (tracker == null)
return null;
return new GCcounter().calculateGCandAddIn(ref);
}
public GCcounter reduce(GCcounter add, GCcounter runningCount) {
if (add == null)
add = new GCcounter();
return runningCount.addIn(add);
}
/**
* @param results the GC content observed for each interval.
*/
public void onTraversalDone(List<Pair<GenomeLoc, GCcounter>> results) {
for (Pair<GenomeLoc, GCcounter> result : results ) {
GenomeLoc loc = result.getFirst();
GCcounter counter = result.getSecond();
double gcContent = (double) counter.GCcount / counter.totalCount;
out.println(loc + "\t" + gcContent + "\t" + loc.size());
}
}
}
class GCcounter {
public int totalCount;
public int GCcount;
public GCcounter() {
this.totalCount = 0;
this.GCcount = 0;
}
public GCcounter addIn(GCcounter other) {
this.totalCount += other.totalCount;
this.GCcount += other.GCcount;
return this;
}
public GCcounter calculateGCandAddIn(ReferenceContext ref) {
for (byte base : ref.getBases()) {
int baseIndex = BaseUtils.simpleBaseToBaseIndex(base);
boolean baseIsGC = (baseIndex == BaseUtils.gIndex || baseIndex == BaseUtils.cIndex);
boolean baseIsAT = (baseIndex == BaseUtils.aIndex || baseIndex == BaseUtils.tIndex);
if (baseIsGC || baseIsAT) {
totalCount++;
if (baseIsGC)
GCcount++;
}
}
return this;
}
}

View File

@ -1,71 +0,0 @@
package org.broadinstitute.sting.oneoffprojects.walkers;
import org.broadinstitute.sting.gatk.contexts.AlignmentContext;
import org.broadinstitute.sting.gatk.contexts.ReferenceContext;
import org.broadinstitute.sting.gatk.refdata.RefMetaDataTracker;
import org.broadinstitute.sting.gatk.refdata.utils.GATKFeature;
import org.broadinstitute.sting.gatk.walkers.RefWalker;
import org.broadinstitute.sting.utils.BaseUtils;
import org.broadinstitute.sting.utils.GenomeLoc;
import org.broadinstitute.sting.utils.collections.Pair;
import org.broadinstitute.sting.commandline.Output;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.io.PrintStream;
/**
* IF THERE IS NO JAVADOC RIGHT HERE, YELL AT chartl
*
* @Author chartl
* @Date May 19, 2010
*/
public class GCCalculatorWalker extends RefWalker<Pair<Set<GenomeLoc>,Boolean>, Map<GenomeLoc,Pair<Long,Long>>> {
@Output
PrintStream out;
public Map<GenomeLoc,Pair<Long,Long>> reduceInit() {
return new HashMap<GenomeLoc,Pair<Long,Long>>();
}
public Pair<Set<GenomeLoc>,Boolean> map(RefMetaDataTracker tracker, ReferenceContext ref, AlignmentContext context) {
if ( tracker == null || tracker.getReferenceMetaData("interval_list") == null ) {
return null;
} else {
Set<GenomeLoc> overlappingIntervals = new HashSet<GenomeLoc>();
for ( GATKFeature f : tracker.getGATKFeatureMetaData("interval_list",true) ) {
overlappingIntervals.add( f.getLocation() );
}
return new Pair<Set<GenomeLoc>,Boolean>(overlappingIntervals, ref.getBaseIndex() == BaseUtils.cIndex || ref.getBaseIndex() == BaseUtils.gIndex );
}
}
public Map<GenomeLoc,Pair<Long,Long>> reduce(Pair<Set<GenomeLoc>,Boolean> map, Map<GenomeLoc,Pair<Long,Long>> prevReduce) {
if ( map == null ) {
return prevReduce;
}
for ( GenomeLoc loc : map.first ) {
if ( ! prevReduce.keySet().contains(loc) ) {
prevReduce.put(loc,new Pair<Long,Long>(0l,0l));
}
prevReduce.get(loc).first ++;
if ( map.second ) {
prevReduce.get(loc).second ++;
}
}
return prevReduce;
}
public void onTraversalDone(Map<GenomeLoc,Pair<Long,Long>> reduced ) {
for ( Map.Entry<GenomeLoc,Pair<Long,Long>> gcCounts : reduced.entrySet() ) {
double gc_content = ( (double) gcCounts.getValue().second )/( (double) gcCounts.getValue().first );
out.printf("%s\t%.2f%n",gcCounts.getKey().toString(),100*gc_content);
}
}
}