Browse code

Renamed new function to calculateBamCoverageByInterval.

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/PureCN@117415 bc3139a8-67e5-0310-9ffc-ced21a209358

Markus Riester authored on 12/05/2016 23:01:36
Showing 5 changed files

... ...
@@ -1,7 +1,7 @@
1 1
 1.2
2 2
     - added calculatePowerDetectSomatic
3 3
     - added getSexFromVcf
4
-    - added calculateBamCoverageFromInterval
4
+    - added calculateBamCoverageByInterval
5 5
 
6 6
 1.0
7 7
     - added correctCoverageBias
... ...
@@ -10,6 +10,7 @@ export(correctCoverageBias)
10 10
 export(findFocal)
11 11
 export(readCurationFile)
12 12
 export(calculatePowerDetectSomatic)
13
+export(calculateBamCoverageByInterval)
13 14
 export(createCurationFile)
14 15
 export(createNormalDatabase)
15 16
 export(createSNPBlacklist)
16 17
similarity index 95%
17 18
rename from R/calculateBamCoverageFromInterval.R
18 19
rename to R/calculateBamCoverageByInterval.R
... ...
@@ -1,4 +1,4 @@
1
-calculateBamCoverageFromInterval <- structure(
1
+calculateBamCoverageByInterval <- structure(
2 2
 function(# Function to calculate coverage from BAM file
3 3
 ### Takes a BAM file and an interval file as input and 
4 4
 ### returns coverage for each interval.
... ...
@@ -52,5 +52,5 @@ output.file=NULL
52 52
 }, ex=function() {
53 53
 gc.gene.file <- system.file("extdata", "example_gc.gene.file.txt", 
54 54
     package="PureCN")
55
-# calculateBamCoverageFromInterval(bam.file, gc.gene.file)   
55
+# calculateBamCoverageByInterval(bam.file, gc.gene.file)   
56 56
 })    
57 57
similarity index 74%
58 58
rename from man/calculateBamCoverageFromInterval.Rd
59 59
rename to man/calculateBamCoverageByInterval.Rd
... ...
@@ -1,9 +1,9 @@
1
-\name{calculateBamCoverageFromInterval}
2
-\alias{calculateBamCoverageFromInterval}
1
+\name{calculateBamCoverageByInterval}
2
+\alias{calculateBamCoverageByInterval}
3 3
 \title{Function to calculate coverage from BAM file}
4 4
 \description{Takes a BAM file and an interval file as input and 
5 5
 returns coverage for each interval.}
6
-\usage{calculateBamCoverageFromInterval(bam.file, interval.file, 
6
+\usage{calculateBamCoverageByInterval(bam.file, interval.file, 
7 7
     output.file = NULL)}
8 8
 \arguments{
9 9
   \item{bam.file}{Filename of a BAM file.}
... ...
@@ -23,5 +23,5 @@ readCoverageGatk function.}
23 23
 \examples{
24 24
 gc.gene.file <- system.file("extdata", "example_gc.gene.file.txt", 
25 25
     package="PureCN")
26
-# calculateBamCoverageFromInterval(bam.file, gc.gene.file)   
26
+# calculateBamCoverageByInterval(bam.file, gc.gene.file)   
27 27
 }
... ...
@@ -82,7 +82,7 @@ provided in \software{GATK DepthOfCoverage} format:
82 82
 \Biocpkg{PureCN} will only use data from the columns "Target",
83 83
 "total\_coverage", and "average\_coverage", all other columns are optional. If
84 84
 \software{GATK} is not available, then the
85
-\Rfunction{calculateBamCoverageFromInterval} function can be used to generate
85
+\Rfunction{calculateBamCoverageByInterval} function can be used to generate
86 86
 the required coverage data from BAM files.  We also refer to the
87 87
 \CRANpkg{ExomeCNV} \cite{Sathirapongsasuti2011} package and documentation,
88 88
 which provides different scripts for generating coverage files from BAM files.