| Title: | Multi sample aCGH analysis package using kernel convolution |
|---|---|
| Description: | Multi sample aCGH analysis package using kernel convolution |
| Authors: | Jorma de Ronde, Christiaan Klijn, Arno Velds |
| Maintainer: | Jorma de Ronde <[email protected]> |
| License: | GPL-3 |
| Version: | 2.63.0 |
| Built: | 2024-07-03 05:32:38 UTC |
| Source: | https://github.com/bioc/KCsmart |
Multiple sample aCGH analysis using kernel convolution
| Package: | KCsmart |
| Type: | Package |
| Version: | 2.9.1 |
| Date: | 2011-02-21 |
| License: | GPL |
Use the wrapper function 'calcSpm' to calculate the sample point matrix. Use 'findSigLevelTrad' to find a significance threshold using permutation based testing. Use 'plot' to plot the sample point matrix or 'plotScaleSpace' to plot the significant regions over multiple scales (sigmas). Use 'getSigSegments' to retrieve the significantly gained and lost regions using specific cutoffs. To use the comparative version of KCsmart, use the 'calcSpmCollection', 'compareSpmCollection' and 'getSigRegionsCompKC' functions. See the documentation of those function for details on how to use these.
Jorma de Ronde, Christiaan Klijn
Maintainer: Jorma de Ronde <[email protected]>
Identification of cancer genes using a statistical framework for multiexperiment analysis of nondiscretized array CGH data. Nucleic Acids Res. 2008 Feb;36(2):e13.
calcSpm, findSigLevelTrad, findSigLevelFdr, plot, plotScaleSpace, getSigSegments
data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) spm4mb <- calcSpm(hsSampleData, hsMirrorLocs, sigma=4000000) plot(spm1mb) plot(spm1mb, chromosomes=c(1,5,6,'X')) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) siglevel4mb <- findSigLevelTrad(hsSampleData, spm4mb, n=3) plot(spm1mb, sigLevel=siglevel1mb) plotScaleSpace(list(spm1mb, spm4mb), list(siglevel1mb, siglevel4mb), type='g') sigSegments1mb <- getSigSegments(spm1mb, siglevel1mb) spmc1mb <- calcSpmCollection(hsSampleData, hsMirrorLocs, cl=c(rep(0,10),rep(1,10))) spmcc1mb <- compareSpmCollection(spmc1mb, nperms=3) spmcc1mbSigRegions <- getSigRegionsCompKC(spmcc1mb) plot(spmcc1mb, sigRegions=spmcc1mbSigRegions)data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) spm4mb <- calcSpm(hsSampleData, hsMirrorLocs, sigma=4000000) plot(spm1mb) plot(spm1mb, chromosomes=c(1,5,6,'X')) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) siglevel4mb <- findSigLevelTrad(hsSampleData, spm4mb, n=3) plot(spm1mb, sigLevel=siglevel1mb) plotScaleSpace(list(spm1mb, spm4mb), list(siglevel1mb, siglevel4mb), type='g') sigSegments1mb <- getSigSegments(spm1mb, siglevel1mb) spmc1mb <- calcSpmCollection(hsSampleData, hsMirrorLocs, cl=c(rep(0,10),rep(1,10))) spmcc1mb <- compareSpmCollection(spmc1mb, nperms=3) spmcc1mbSigRegions <- getSigRegionsCompKC(spmcc1mb) plot(spmcc1mb, sigRegions=spmcc1mbSigRegions)
Wrapper function that calculates the sample point matrix from the aCGH data
calcSpm(data, mirrorLocs, sigma = 1e+06, sampleDensity = 50000, maxmem = 1000, verbose=T, old=F)calcSpm(data, mirrorLocs, sigma = 1e+06, sampleDensity = 50000, maxmem = 1000, verbose=T, old=F)
data |
The aCGH data. Can either be in DNAcopy format or as a data.frame described in the details section |
mirrorLocs |
List containing the chromosome start, centromere and end positions |
sigma |
The kernel width |
sampleDensity |
The sample point matrix resolution |
maxmem |
This parameter controls memory usage, set to lower value to lower memory consumption |
verbose |
If set to false, no progress information is displayed |
old |
If set to true the old implementation of KCsmart will be used to calculate the spm |
'data' can be in cghRaw (CGHbase), DNAcopy or in data.frame format. When using the latter, the data.frame must have the following two columns: 'chrom' stating the chromosome the probe is located on, 'maploc' describing the position on the chromosome of the probe. The remainder of the data.frame will be interpreted as sample data points. The row names of that data will be used as probe names (when available). Important note: the data can not contain any missing values. If your data includes missing values you will need to preprocess (for example impute) it using other software solutions.
The mirror locations for Homo Sapiens and Mus Musculus are provided in the package. These can be loaded using data(hsMirrorLocs) and data(mmMirrorLocs) respectively. The 'mirrorLocs' object is a list with vectors containing the start, centromere (optional) and end of each chromosome as the list elements. Additionally it should contain an attribute 'chromNames' listing the chromosome names of each respective list element.
'sigma' defines the kernel width of the kernel used to convolute the data.
'sampleDensity' defines the resolution of the sample point matrix to be calculated. A sampleDensity of 50000 would correspond to a sample point every 50k base pairs.
'old' can be used if you want to reproduce data that was generated with old (pre 2.9.0) versions of KCsmart, for any new analyses we recommend this flag to be set to false
Returns a sample point matrix object. The object has several slots of which the 'data' slot contains a list where each list item represents a chromosome. Each list item in turn contains the sample point matrix for the gains and the losses separately and an attribute specifying the corresponding chromosome. The sample point matrix contains the following additional slots: totalLength: Total length of the sample point matrix maxy and miny: Maximal and minimal score attained
The other slots just represent the parameters used to calculate the sample point matrix.
Use 'plot' to plot the sample point matrix and 'findSigLevelTrad' to find a significance threshold. 'plotScaleSpace' can be used to plot the significant regions of multiple sample point matrices (using different sigmas).
Jorma de Ronde
plot, findSigLevelTrad, plotScaleSpace
data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) spm4mb <- calcSpm(hsSampleData, hsMirrorLocs, sigma=4000000) plot(spm1mb) plot(spm1mb, chromosomes=c(1,5,6,'X'))data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) spm4mb <- calcSpm(hsSampleData, hsMirrorLocs, sigma=4000000) plot(spm1mb) plot(spm1mb, chromosomes=c(1,5,6,'X'))
Wrapper function that calculates the sample point matrix collection from the aCGH data. The sample point matrix collection is used in the comparative version of KCsmart.
calcSpmCollection(data, mirrorLocs, cl=NULL, data2=NULL, sigma=1000000, sampleDensity=50000, maxmem=1000, verbose=F, doChecks=T, old=F)calcSpmCollection(data, mirrorLocs, cl=NULL, data2=NULL, sigma=1000000, sampleDensity=50000, maxmem=1000, verbose=F, doChecks=T, old=F)
data |
The aCGH data. Can either be in DNAcopy format or as a data.frame described in the details section |
mirrorLocs |
List containing the chromosome start, centromere and end positions |
cl |
A class vector indicating which samples belong to which class |
data2 |
Instead of a class vector a second data set can be provided which will be combined with the first data set into one sample point matrix collection |
sigma |
The kernel width |
sampleDensity |
The sample point matrix resolution |
maxmem |
This parameter controls memory usage, set to lower value to lower memory consumption |
verbose |
If set to false, no progress information is displayed |
doChecks |
If set to false, the data will not be checked for consistency |
old |
If set to true the old implementation of KCsmart will be used to calculate the spm |
The input can either consist of a single data set and a class vector or two separate datasets. In the latter case a class vector will be created assigning each data set to its own class. 'data' can be in cghRaw (CGHbase), DNAcopy or in data.frame format. When using the latter, the data.frame must have the following two columns: 'chrom' stating the chromosome the probe is located on, 'maploc' describing the position on the chromosome of the probe. The remainder of the data.frame will be interpreted as sample data points. The row names of that data will be used as probe names (when available). Important note: the data can not contain any missing values. If your data includes missing values you will need to preprocess (for example impute) it using other software solutions.
The mirror locations for Homo Sapiens and Mus Musculus are provided in the package. These can be loaded using data(hsMirrorLocs) and data(mmMirrorLocs) respectively. The 'mirrorLocs' object is a list with vectors containing the start, centromere (optional) and end of each chromosome as the list elements. Additionally it should contain an attribute 'chromNames' listing the chromosome names of each respective list element.
'sigma' defines the kernel width of the kernel used to convolute the data.
'sampleDensity' defines the resolution of the sample point matrix to be calculated. A sampleDensity of 50000 would correspond to a sample point every 50k base pairs.
'old' can be used if you want to reproduce data that was generated with old (pre 2.9.0) versions of KCsmart, for any new analyses we recommend this flag to be set to false
Returns a sample point matrix collection object. The object has several slots of which the 'data' slot contains a matrix with the kernel smoothed estimates of all samples. The sample point matrix collection contains the following additional slots: cl: A class vector indicating which samples belong to which class. annotation: The annotation (containing the chromosome and position on the chromosome) for the sample points in the 'data' slot
The other slots just represent the parameters used to calculate the sample point matrix collection.
Use 'compareSpmCollection' to get a 'compKc' object for which the significant regions can be calculated using 'getSigRegionsCompKC'.
Jorma de Ronde
compareSpmCollection, getSigRegionsCompKC
data(hsSampleData) data(hsMirrorLocs) spmc1mb <- calcSpmCollection(hsSampleData, hsMirrorLocs, cl=c(rep(0,10),rep(1,10))) spmcc1mb <- compareSpmCollection(spmc1mb, nperms=3) spmcc1mbSigRegions <- getSigRegionsCompKC(spmcc1mb) plot(spmcc1mb, sigRegions=spmcc1mbSigRegions)data(hsSampleData) data(hsMirrorLocs) spmc1mb <- calcSpmCollection(hsSampleData, hsMirrorLocs, cl=c(rep(0,10),rep(1,10))) spmcc1mb <- compareSpmCollection(spmc1mb, nperms=3) spmcc1mbSigRegions <- getSigRegionsCompKC(spmcc1mb) plot(spmcc1mb, sigRegions=spmcc1mbSigRegions)
Compare the samples of one class in the sample point matrix collection to the samples in the other class and calculate the null distribution
compareSpmCollection(spmCollection, nperms=20, method=c("siggenes", "perm"), siggenes.args=NULL, altcl=NULL)compareSpmCollection(spmCollection, nperms=20, method=c("siggenes", "perm"), siggenes.args=NULL, altcl=NULL)
spmCollection |
An spmCollection object as created by the 'calcSpmCollection' function |
nperms |
The number of permutations to be used to calculate the null distribution |
altcl |
Instead of using the class vector from the spmCollection object an alternative vector can be used |
method |
The method to be used to calculate the null distribution |
siggenes.args |
Optional additional arguments to the siggenes function |
The method to be used to determine significant regions can either be the SAM methodology from the siggenes package or a signal-to-noise/permutation based method. For more information regarding the siggenes method please check the corresponding package.
Returns a compKc object which returns the original data and, depending on the method used, the permuted data or the fdr-delta value combinations as calculated by the siggenes package.
Jorma de Ronde
compareSpmCollection, getSigRegionsCompKC
data(hsSampleData) data(hsMirrorLocs) spmc1mb <- calcSpmCollection(hsSampleData, hsMirrorLocs, cl=c(rep(0,10),rep(1,10))) spmcc1mb <- compareSpmCollection(spmc1mb, nperms=3) spmcc1mbSigRegions <- getSigRegionsCompKC(spmcc1mb) plot(spmcc1mb, sigRegions=spmcc1mbSigRegions)data(hsSampleData) data(hsMirrorLocs) spmc1mb <- calcSpmCollection(hsSampleData, hsMirrorLocs, cl=c(rep(0,10),rep(1,10))) spmcc1mb <- compareSpmCollection(spmc1mb, nperms=3) spmcc1mbSigRegions <- getSigRegionsCompKC(spmcc1mb) plot(spmcc1mb, sigRegions=spmcc1mbSigRegions)
A matrix containing the results from a call to compareSpmCollection
Objects can not be created by the user directly but rather through compareSpmCollection.
spmCollection:The original spmCollection used to compare the samples
method:The method used to create the null distribution
siggenesResult:In case of the siggenes method being used, a siggenes object containing the fdr-cutoff table
snrResult:In case of the signal-noise/permutation based method being used, the signal-to-noise data and a matrix with the (class based) permutations
signature(.Object = "compKc"): Internal use only
signature(x = "compKc"): ...
signature(object = "compKc"): ...
showClass("compKc")showClass("compKc")
A matrix containing the results the significant regions for a given compKc object and FDR.
Objects can not be created by the user directly but rather through getSigRegionsCompKC.
regionTable:The significant regions
method:The method used to create the null distribution
cutoff:The cutoff for the given false discovery rate which was used to determine the significant regions
fdr:The false discovery rate used to determine the significant regions
signature(object = "compKcSigRegions"): ...
signature(object = "compKcSigRegions"): ...
showClass("compKcSigRegions")showClass("compKcSigRegions")
Method to find the cutoff at which gains and losses are considered significant using permutations
findSigLevelFdr(data, observedSpm, n = 1, fdrTarget=0.05, maxmem=1000)findSigLevelFdr(data, observedSpm, n = 1, fdrTarget=0.05, maxmem=1000)
data |
aCGH data in the same format as used for 'calcSpm' |
observedSpm |
A sample point matrix as produced by 'calcSpm' |
n |
Number of permutations |
fdrTarget |
Target False Discovery Rate (FDR) |
maxmem |
This parameter controls memory usage, set to lower value to lower memory consumption |
The number of permutations needed for reliable results depends on the data and can not be determined beforehand. As a general rule-of-thumb around 100 permutations should be used for 'quick checks' and around 2000 permutations for more rigorous testing. The FDR method is less conservatie than the p-value based approach since instead of controlling the family wise error rate (FWER, P(false positive > 1)) it controls the false discovery rate (FDR) (false positives / total number of called data points).
A list with the cutoffs corresponding to the given FDR
pos |
The cutoff for the gains |
neg |
The cutoff for the losses' |
Jorma de Ronde
data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) sigLevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) plot(spm1mb, sigLevels=sigLevel1mb) plotScaleSpace(list(spm1mb), list(sigLevel1mb), type='g')data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) sigLevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) plot(spm1mb, sigLevels=sigLevel1mb) plotScaleSpace(list(spm1mb), list(sigLevel1mb), type='g')
Method to find the cutoff at which gains and losses are considered significant using permutations
findSigLevelTrad(data, observedSpm, n = 1, p = 0.05, maxmem = 1000)findSigLevelTrad(data, observedSpm, n = 1, p = 0.05, maxmem = 1000)
data |
aCGH data in the same format as used for 'calcSpm' |
observedSpm |
A sample point matrix as produced by 'calcSpm' |
n |
Number of permutations |
p |
Alpha level for significance |
maxmem |
This parameter controls memory usage, set to lower value to lower memory consumption |
The number of permutations needed for reliable results depends on the data and can not be determined beforehand. As a general rule-of-thumb around 100 permutations should be used for 'quick checks' and around 2000 permutations for more rigorous testing.
p is the uncorrected alpha level, the method corrects for multiple testing internally using simple Bonferroni correction. See the referenced publication for more details.
A list with the cutoffs corresponding to the given alpha level
pos |
The cutoff for the gains |
neg |
The cutoff for the losses' |
Jorma de Ronde
data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) sigLevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) plot(spm1mb, sigLevels=sigLevel1mb) plotScaleSpace(list(spm1mb), list(sigLevel1mb), type='g')data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) sigLevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) plot(spm1mb, sigLevels=sigLevel1mb) plotScaleSpace(list(spm1mb), list(sigLevel1mb), type='g')
Extract the significant regions from a compKC object for a given false discovery rate (FDR).
getSigRegionsCompKC(compKc, fdr=.01, maxRegionGap=10)getSigRegionsCompKC(compKc, fdr=.01, maxRegionGap=10)
compKc |
A compKc object as created by the 'compareSpmCollection' function |
fdr |
The false discovery rate to be used to calculate the significantly different regions from the compKc object |
maxRegionGap |
The maximum number of sample points that is allowed to fall under the threshold in a continuous significant region |
The false discovery rate that is set is used to determine the significant regions. When the compKc object was created by the siggenes method the corresponding cutoff is looked up in the siggenes results table, otherwise it is calculated from the permuted data. The maxRegionGap determines how many sample points can be under this threshold in a continuous significant region.
Returns a compKcSigRegions object that contains the significant regions for the given FDR in the 'regionTable' slot. The method used to determine the cutoff, the fdr and the cutoff itself are stored in their corresponding slots. Use 'plot' to visualize the results.
Jorma de Ronde
compareSpmCollection, getSigRegionsCompKC
data(hsSampleData) data(hsMirrorLocs) spmc1mb <- calcSpmCollection(hsSampleData, hsMirrorLocs, cl=c(rep(0,10),rep(1,10))) spmcc1mb <- compareSpmCollection(spmc1mb, nperms=3) spmcc1mbSigRegions <- getSigRegionsCompKC(spmcc1mb) plot(spmcc1mb, sigRegions=spmcc1mbSigRegions)data(hsSampleData) data(hsMirrorLocs) spmc1mb <- calcSpmCollection(hsSampleData, hsMirrorLocs, cl=c(rep(0,10),rep(1,10))) spmcc1mb <- compareSpmCollection(spmc1mb, nperms=3) spmcc1mbSigRegions <- getSigRegionsCompKC(spmcc1mb) plot(spmcc1mb, sigRegions=spmcc1mbSigRegions)
Retrieve the significantly gained and lost regions including the corresponding, original probes. A significance level must be selected by the user.
getSigSegments(spm, sigLevels, chromosomes=NULL)getSigSegments(spm, sigLevels, chromosomes=NULL)
spm |
The sample point matrix to be plotted |
sigLevels |
The significance thresholds to be used |
chromosomes |
Takes a vector of chromosomes to be plotted. Defaults to all chromosomes. |
'sigLevels' should contain the significance thresholds in a list with the positive (gains) threshold in the 'pos' element and the negative (losses) threshold in the 'neg' element. This is the format as returned by 'findSigLevelTrad' and 'findSigLevelFdr'.
Returns a sigSegments object containing the chromosome, start position, end position, average KC score and the mode of the KC score in that region of all segments passing the thresholds as set in 'sigLevels'. Additionally, returns the IDs and indices of the probes and the positions in the sample point matrix within the significant regions. The results are stored in two separate slots: 'gains' for gains and 'losses' for losses. Use 'write.table' to save the results to file.
Jorma de Ronde
~put references to the literature/web site here ~
findSigLevelTrad, findSigLevelTrad, write.table
data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) sigSegments1mb <- getSigSegments(spm1mb, siglevel1mb) write.table(sigSegments1mb, file=file.path(tempdir(),'sigSegments1mb.txt'))data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) sigSegments1mb <- getSigSegments(spm1mb, siglevel1mb) write.table(sigSegments1mb, file=file.path(tempdir(),'sigSegments1mb.txt'))
Mirror locations of the human genome, based on the NCBI 36 assembly of the human genome, for use with the KCsmart package.
hsMirrorLocshsMirrorLocs
A list containing for each chromosome the start and end position and the centromere location (if a centromere is present).
Ensembl
http://www.ensembl.org
An artificial cgh data set, created by permuting a BAC data set consisting of 20 samples and introducing an artificial gain on 1p. To be used with the KCsmart package.
hsSampleDatahsSampleData
A data.frame containing 3268 rows and 22 columns
Artificial data set
Identify points in sample point matrix plot
idPoints(spm, mode='pos', dev=2, chromosomes=NULL)idPoints(spm, mode='pos', dev=2, chromosomes=NULL)
spm |
The sample point matrix object of which points are to be identified |
mode |
Determines which points will be identified: mode='pos' will identify points in gained regions, mode='neg' will identify points in lost regions |
dev |
The device on which the sample point matrix was plotted |
chromosomes |
If not all chromosomes contained in the sample point matrix were plotted (using the 'chromosomes' argument in the 'plot' command), the same chromosomes must be entered here as an argument |
Using the mouse pointer points in a sample point matrix plot can be identified by left-clicking on the to-be-identified points. Right-clicking exits the selection and returns the selected points.
Returns a data.frame listing the the position and the KC score for each identified point.
KCscore |
KCscore of the identified point |
chromosome |
Chromosome on which the identified point is located |
chromPosition |
Position on the chromosome of the identified point |
colin |
Co-linear location of the identified point (given the selected chromosomes) |
Jorma de Ronde
data(hsSampleData) data(hsMirrorLocs) #spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) #plot(spm1mb, type=1) #idPoints(spm1mb) #x11() #plot(spm1mb, chromosomes=c(1,2,5)) #idPoints(spm1mb, mode='neg', dev=3, chromosomes=c(1,2,5))data(hsSampleData) data(hsMirrorLocs) #spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) #plot(spm1mb, type=1) #idPoints(spm1mb) #x11() #plot(spm1mb, chromosomes=c(1,2,5)) #idPoints(spm1mb, mode='neg', dev=3, chromosomes=c(1,2,5))
Internal superclass "KCData"
The user is not meant to create instances of this class
data:Internal data
signature(x = "KCData"): ...
signature(x = "KCData"): ...
signature(x = "KCData"): ...
signature(x = "KCData"): ...
This class is meant for internal use only
Internal class
Jorma de Ronde
Internal class
probeAnnotation:Object of class "probeAnnotation"
data:Holds aCGH data
signature(.Object = "KcghData"): Internal use only
signature(x = "KcghData"): Internal use only
For internal use only
Jorma de Ronde
Internal class
mirrorLocs:Holds mirrorLocs object
probeAnnotation:Object of class "probeAnnotation"
pos:Holds aCGH data for losses
neg:Holds aCGH data for gains
nrSamples:The number of samples in this analysis
Class "KcghDataSum", directly.
signature(.Object = "KcghDataMirror"): For internal use only
For internal use only
Jorma de Ronde
Internal class
probeAnnotation:Object of class "probeAnnotation"
pos:Holds aCGH data for losses
neg:Holds aCGH data for gains
signature(.Object = "KcghDataSplit"): Internal use only
For internal use only
Jorma de Ronde
Internal class
probeAnnotation:Object of class "probeAnnotation"
pos:Holds aCGH data for losses
neg:Holds aCGH data for gains
nrSamples:The number of samples in this analysis
signature(.Object = "KcghDataSum"): For internal use only
signature(x = "KcghDataSum"): For internal use only
For internal use only
Jorma de Ronde
Mirror locations of the mouse genome, based on the NCBI m37 mouse assembly, for use with the KCsmart package.
mmMirrorLocsmmMirrorLocs
A list containing for each chromosome the start and end position.
Ensembl
http://www.ensembl.org
Plot the sample point matrix or parts of it
plot(x,y, ...) ## S4 method for signature 'scaleSpace,missing' plot(x, y, spm, type='b', ...) ## S4 method for signature 'samplePointMatrix,missing' plot(x, y, type="b", sigLevels=NULL, chromosomes=NULL, colinAxis=NULL, fillColor=NULL, maploc=NULL, interpolation=1, main=NULL, col=NULL, ylim=NULL, add=F, ...) ## S4 method for signature 'compKc,missing' plot(x, sigRegions=NULL, type="1", chromosomes=NULL, colinAxis=NULL, maploc=NULL, interpolation=1, main=NULL, col1=NULL, col2=NULL, ylim=NULL, add=F, ...)plot(x,y, ...) ## S4 method for signature 'scaleSpace,missing' plot(x, y, spm, type='b', ...) ## S4 method for signature 'samplePointMatrix,missing' plot(x, y, type="b", sigLevels=NULL, chromosomes=NULL, colinAxis=NULL, fillColor=NULL, maploc=NULL, interpolation=1, main=NULL, col=NULL, ylim=NULL, add=F, ...) ## S4 method for signature 'compKc,missing' plot(x, sigRegions=NULL, type="1", chromosomes=NULL, colinAxis=NULL, maploc=NULL, interpolation=1, main=NULL, col1=NULL, col2=NULL, ylim=NULL, add=F, ...)
x |
either an object of class samplePointMatrix, scaleSpace or compKc |
y |
object of class missing |
type |
Determines which data is plotted. 'g' for gains only, 'l' for losses only and 'b' and '1' for both in one plot device |
spm |
add stuff here |
sigRegions |
The significant regions as calculated by the compKcSigRegions function |
sigLevels |
If given, the cutoffs will be drawn as lines in the plots. Optional |
chromosomes |
Takes a vector of chromosomes to be plotted. Defaults to all chromosomes. |
colinAxis |
Allows you to override default behaviour of axis labeling. Choose False for genomic position labeling for each individual chromosome, True for colinear labeling. |
fillColor |
Allows you to choose the colors used to fill the significant areas under the curve. Takes a list with the 'pos' element giving the color for the gains and the 'neg' element the color for the losses. |
maploc |
Currently not in use |
interpolation |
Determines which points from the sample point matrix will actually be plotted. If the value of 'interpolation' is n, then every n-th point will be plotted. The default value of 1 will results in all points being plotted. This can be useful when a high density sample point matrix results in big file size when exporting the image (especially to pdf or eps format). |
main |
Set the title of the plot |
col |
Set the color of the plotted lines |
col1 |
Set the color of the plotted lines |
col2 |
Set the color of the plotted lines |
ylim |
Set the y-axis limits |
add |
When set to true the plot is added to the current plot device |
... |
Any other parameters you would like to pass to 'plot'. See 'par' for more details. |
Plots the sample point matrix. The gains and the losses are plotted separately. The KC normalized score is plotted on the y-axis, the genomic position on the x-axis. If centromeres are present these are represented by dotted, lightblue lines. Setting type to 'b' or to '1' will both make the plot appear in one plot device, '1' will plot the gains and the losses in one plot, 'b' will plot the gains and losses separately. Using the 'add' flag it is possible to add a plot to the current plot device. The 'col' and 'ylim' arguments can be used to set the color of each plot and the plot regions. The function 'idPoints' can be used to identify points in the sample point matrix plot. See the corresponding documentation for details.
In case of plotting a compKc object, col1 and col2 can be used to set the colors of the group 1 and group 2 mean values respectively.
Jorma de Ronde
calcSpm, plotScaleSpace, idPoints
data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) plot(spm1mb) plot(spm1mb, interpolation=10) plot(spm1mb, chromosomes=c(1,4,'X')) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) plot(spm1mb, chromosomes=c(1,4,'X'), sigLevels=siglevel1mb) plot(spm1mb, chromosomes=c(1,4,'X'), sigLevels=siglevel1mb, fillColor=list(pos='darkred',neg='darkgreen'))data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) plot(spm1mb) plot(spm1mb, interpolation=10) plot(spm1mb, chromosomes=c(1,4,'X')) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) plot(spm1mb, chromosomes=c(1,4,'X'), sigLevels=siglevel1mb) plot(spm1mb, chromosomes=c(1,4,'X'), sigLevels=siglevel1mb, fillColor=list(pos='darkred',neg='darkgreen'))
Plots significant regions in different scale spaces in one figure
plotScaleSpace(spms, sigLevels, chromosomes=NULL, type='b')plotScaleSpace(spms, sigLevels, chromosomes=NULL, type='b')
spms |
List of sample point matrices |
sigLevels |
List of significance levels |
chromosomes |
Takes a vector of chromosomes to be plotted. Defaults to all chromosomes. |
type |
Determines which data is plotted. 'g' for gains only, 'l' for losses only and 'b' for both. When type='b' is used, two devices (x11) will be opened. |
Takes sample point matrices that were calculated using (different) kernel widths (sigma), then calculates the significant regions given the cutoffs as defined by 'sigLevels' and plots these in one figure.
Depending on the 'type' parameter, produces one or two plots, one for the gains and one for the losses. The heatmap color indicates the level of the gain or loss.
Jorma de Ronde
data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) spm4mb <- calcSpm(hsSampleData, hsMirrorLocs, sigma=4000000) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) siglevel4mb <- findSigLevelTrad(hsSampleData, spm4mb, n=3) plotScaleSpace(list(spm1mb, spm4mb), list(siglevel1mb, siglevel4mb), type='g')data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) spm4mb <- calcSpm(hsSampleData, hsMirrorLocs, sigma=4000000) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) siglevel4mb <- findSigLevelTrad(hsSampleData, spm4mb, n=3) plotScaleSpace(list(spm1mb, spm4mb), list(siglevel1mb, siglevel4mb), type='g')
Holds the probe annotation
Instances of this class are not meant to be created by the user
chromosome:Chromosome on which the probe is located
maploc:Location of the probe on the chromosome
name:Probe name
signature(x = "probeAnnotation"): Access information about a probe
signature(.Object = "probeAnnotation"): Internal use only
Jorma de Ronde
A sample point matrix resulting from a call to calcSpm
Objects can not be created by the user directly but rather through calcSpm.
totalLength:The total length of the sample point matrix, measures in sample points
maxy:The maximum KC score attained over the sample point matrix
miny:The minimum KC score attained over the sample point matrix
sampleDensity:The sample density used to calculate the sample point matrix. ie the distance between two points in the sample point matrix, measured in base pairs.
sigma:The sigma used for the kernel to calculate the sample point matrix.
mirrorLocs:The mirror locations list used to calculate the sample point matrix
probeAnnotation:The original probe annotation from the input data.
data:The sample point matrix data points in the form of a list where each list element represents a chromosome.
signature(x = "samplePointMatrix"): ...
signature(object = "samplePointMatrix"): ...
showClass("samplePointMatrix")showClass("samplePointMatrix")
Lists the significant segments found in a given sample point matrix using a given significance level
Objects can not be created by the user directly but rather through getSigSegments.
gains:Gained segments
losses:Lost segments
sigma:The sigma used for the kernel to calculate the sample point matrix.
sigLevels:The significance levels at which significant segments are calculated
signature(object = "sigSegments"): ...
signature(x = "sigSegments"): ...
showClass("sigSegments")showClass("sigSegments")
A sample point matrix collection resulting from a call to calcSpmCollection
Objects can not be created by the user directly but rather through calcSpmCollection.
annotation:The annotation (containing the chromosome and position on the chromosome) for the sample points in the 'data' slot
data:A matrix with the kernel smoothed estimates of all samples
cl:A class vector indicating which samples belong to which class
sampleDensity:The sample density used to calculate the sample point matrix. ie the distance between two points in the sample point matrix, measured in base pairs.
sigma:The sigma used for the kernel to calculate the sample point matrix.
mirrorLocs:The mirror locations list used to calculate the sample point matrix
signature(object = "spmCollection"): ...
showClass("spmCollection")showClass("spmCollection")
Write summary of the significant regions to a table
write.table(x, file = "", append = FALSE, quote = TRUE, sep = " ", eol = "\n", na = "NA", dec = ".", row.names = TRUE, col.names = TRUE, qmethod = c("escape", "double"), fileEncoding = "") ## S4 method for signature 'sigSegments' write.table(x, file="", append = FALSE, quote = 7, sep = "\t", eol = "\n", na = "NA", dec = ".", row.names = TRUE, col.names=c("Status", "Chromosome", "Start", "End", "Average KC score", "Mode KC score", "Probes"), qmethod = c("escape", "double")) ## S4 method for signature 'compKcSigRegions' write.table(x, file="", append = FALSE, quote = 7, sep = "\t", eol = "\n", na = "NA", dec = ".", row.names = FALSE, col.names=c("startrow", "endrow", "chromosome", "startposition", "endposition"), qmethod = c("escape", "double"))write.table(x, file = "", append = FALSE, quote = TRUE, sep = " ", eol = "\n", na = "NA", dec = ".", row.names = TRUE, col.names = TRUE, qmethod = c("escape", "double"), fileEncoding = "") ## S4 method for signature 'sigSegments' write.table(x, file="", append = FALSE, quote = 7, sep = "\t", eol = "\n", na = "NA", dec = ".", row.names = TRUE, col.names=c("Status", "Chromosome", "Start", "End", "Average KC score", "Mode KC score", "Probes"), qmethod = c("escape", "double")) ## S4 method for signature 'compKcSigRegions' write.table(x, file="", append = FALSE, quote = 7, sep = "\t", eol = "\n", na = "NA", dec = ".", row.names = FALSE, col.names=c("startrow", "endrow", "chromosome", "startposition", "endposition"), qmethod = c("escape", "double"))
x |
The sigSegments object to be summarized |
file |
either a character string naming a file or a connection open for writing. '""' indicates output to the console. |
append |
logical. Only relevant if 'file' is a character string. If 'TRUE', the output is appended to the file. If 'FALSE', any existing file of the name is destroyed. |
quote |
a logical value ('TRUE' or 'FALSE') or a numeric vector. If 'TRUE', any character or factor columns will be surrounded by double quotes. If a numeric vector, its elements are taken as the indices of columns to quote. In both cases, row and column names are quoted if they are written. If 'FALSE', nothing is quoted. |
sep |
the field separator string. Values within each row of 'x' are separated by this string. |
eol |
the character(s) to print at the end of each line (row). |
na |
the string to use for missing values in the data. |
dec |
the string to use for decimal points in numeric or complex columns: must be a single character. |
row.names |
either a logical value indicating whether the row names of 'x' are to be written along with 'x', or a character vector of row names to be written. |
col.names |
either a logical value indicating whether the column names of 'x' are to be written along with 'x', or a character vector of column names to be written. See the section on 'CSV files' for the meaning of 'col.names = NA'. |
qmethod |
a character string specifying how to deal with embedded double quote characters when quoting strings. Must be one of '"escape"' (default), in which case the quote character is escaped in C style by a backslash, or '"double"', in which case it is doubled. You can specify just the initial letter. |
fileEncoding |
character string: if non-empty declares the
encoding to be used on a file (not a connection) so the character data can
be re-encoded as they are written. See |
Writes a summary of the sigSegments object to file. The resulting table contains 7 columns. The interpretation of the columns is as follows:
Status Either 'L' for loss or 'G' for gain
Chromosome The chromosome on which this segment is located
Start The start position (in base pairs) of the segment on the chromosome
End The end position of the segment on the chromosome
Average KC scoreThe average KCsmart score over all base pairs in this segment
Mode KC scoreThe highest (for gains) or lowest (for losses) KCsmart score over all base pairs in this segment
Probes All probes from the original data that fall into this segment
Jorma de Ronde
data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) sigSegments1mb <- getSigSegments(spm1mb, siglevel1mb) write.table(sigSegments1mb, file=file.path(tempdir(),'sigSegments1mb.txt'))data(hsSampleData) data(hsMirrorLocs) spm1mb <- calcSpm(hsSampleData, hsMirrorLocs) siglevel1mb <- findSigLevelTrad(hsSampleData, spm1mb, n=3) sigSegments1mb <- getSigSegments(spm1mb, siglevel1mb) write.table(sigSegments1mb, file=file.path(tempdir(),'sigSegments1mb.txt'))