Learn R Programming

⚠️There's a newer version (3.3.2) of this package.Take me there.

aroma.core: Core Methods and Classes Used by 'aroma.*' Packages Part of the Aroma Framework

Installation

This R package is available on CRAN and can be installed in R as:

# install.packages("BiocManager")
BiocManager::install(c("aroma.light", "DNAcopy"))

install.packages("aroma.core")

To install the optional dependency sfit, use:

install.packages("sfit", repos = "https://henrikbengtsson.r-universe.dev")

This will install the package from source. Similarly, to install the rarely needed optional dependencies expectile, HaarSeg, and mpcbs, use:

install.packages("expectile", repos = "https://henrikbengtsson.r-universe.dev")
install.packages("HaarSeg", repos = "https://henrikbengtsson.r-universe.dev")
install.packages("mpcbs", repos = c("https://r-forge.r-project.org", getOption("repos")))

Pre-release version

To install the pre-release version that is available in Git branch develop on GitHub, use:

remotes::install_github("HenrikBengtsson/aroma.core", ref = "develop")

This will install the package from source.

Copy Link

Version

Install

install.packages('aroma.core')

Monthly Downloads

589

Version

3.3.0

License

LGPL (>= 2.1)

Issues

Pull Requests

Stars

Forks

Maintainer

Henrik Bengtsson

Last Published

November 15th, 2022

Functions in aroma.core (3.3.0)

AromaMicroarrayDataSetTuple

The AromaMicroarrayDataSetTuple class
AromaMicroarrayTabularBinaryFile

The AromaMicroarrayTabularBinaryFile class
AromaCellTabularBinaryFile

The AromaCellTabularBinaryFile class
AromaCellCpgFile

A binary file holding local CpG density for each cell (probe/feature)
AromaMicroarrayDataFile

The abstract AromaMicroarrayDataFile class
AbstractCNData

The AbstractCNData class
AbstractPSCNData

The AbstractPSCNData class
AromaCellPositionFile

A binary file holding chromosome/position for each cell
AromaPlatform

The AromaPlatform class
AromaTabularBinarySet

The AromaTabularBinarySet class
AromaTransform

The AromaTransform class
AromaUnitCallFile

The AromaUnitCallFile class
AromaPlatformInterface

The AromaPlatformInterface class
AromaUnitFracBCnBinaryFile

The AromaUnitFracBCnBinaryFile class
AromaUnitPscnBinaryFile

The AromaUnitPscnBinaryFile class
AromaUnitCallSet

The AromaUnitCallSet class
ChromosomeExplorer

The ChromosomeExplorer class
AromaGenomeTextFile

The AromaGenomeTextFile class
AromaUnitPscnBinarySet

The AromaUnitPscnBinarySet class
CopyNumberChromosomalModel

The CopyNumberChromosomalModel class
AromaUnitTabularBinaryFile

The AromaUnitTabularBinaryFile class
AromaMicroarrayDataSet

The AromaMicroarrayDataSet class
AromaUnitFracBCnBinarySet

The AromaUnitFracBCnBinarySet class
AromaUnitTotalCnBinaryFile

The AromaUnitTotalCnBinaryFile class
AromaRepository

The AromaRepository class
AromaUnitSignalBinaryFile

The AromaUnitSignalBinaryFile class
AromaUnitSignalBinarySet

The AromaUnitSignalBinarySet class
FileCacheKeyInterface

The FileCacheKeyInterface class interface
AromaTabularBinaryFile

The AromaTabularBinaryFile class
CbsModel

The CbsModel class
ChromosomalModel

The ChromosomalModel class
RawGenomicSignals

The RawGenomicSignals class
AromaUnitGenotypeCallFile

The AromaUnitGenotypeCallFile class
RawMirroredAlleleBFractions

The RawMirroredAlleleBFractions class
CopyNumberSegmentationModel

The CopyNumberSegmentationModel class
AromaUnitTotalCnBinarySet

The AromaUnitTotalCnBinarySet class
AromaUnitTypesFile

The AromaUnitTypesFile class
HaarSegModel

The HaarSegModel class
Non-documented objects

Non-documented objects
BinnedScatter

The BinnedScatter class
AromaUnitGenotypeCallSet

The AromaUnitGenotypeCallSet class
SegmentedCopyNumbers

The SegmentedCopyNumbers class
exportAromaUnitPscnBinarySet

Export total and allele B signal data sets as a unified parent-specific copy number signal data set
extractRawCopyNumbers.CopyNumberChromosomalModel

Extracts relative copy numbers
SegmentedGenomicSignalsInterface

The SegmentedGenomicSignalsInterface class interface
estimateSds.CopyNumberChromosomalModel

Estimates the standard deviation of the raw copy numbers (log2-ratios) robustly
estimateStandardDeviation.RawGenomicSignals

Estimates the standard deviation of the raw Ys
getFullName.AromaTransform

Gets the full name of the output data set
aroma.core-package

Package aroma.core
Explorer

The Explorer class
CacheKeyInterface

The CacheKeyInterface class interface
GladModel

The GladModel class
as.GrayscaleImage.matrix

Creates a Grayscale (Color) Image from a matrix file
fitGenotypeConeBySfit.matrix

Fits an affine transformation to allele A and allele B data
downloadChipTypeFile.AromaRepository

Download a particular chip type annotation file
downloadFile.AromaRepository

Download a particular file from the repository
RawCopyNumberModel

The RawCopyNumberModel class
getInputDataSet.AromaTransform

Gets the input data set
RawCopyNumbers

The RawCopyNumbers class
getAlias.Explorer

Gets the alias of the output set
getParameters.ParametersInterface

Gets a list of parameters
ParametersInterface

The ParametersInterface class interface
getAromaPlatform.AromaPlatformInterface

Gets the platform
NonPairedPSCNData

The NonPairedPSCNData class
RawAlleleBFractions

The RawAlleleBFractions class
PairedPSCNData

The PairedPSCNData class
getPlatform.AromaPlatformInterface

Gets the platform
UnitTypesFile

The UnitTypesFile interface class
getRootPath.AromaTransform

Gets the root path of the output directory
RawSequenceReads

The RawSequenceReads class
fitMultiDimensionalCone.matrix

Fits an affine transformation to multi-dimensional data
UnitAnnotationDataFile

The UnitAnnotationDataFile interface class
SegmentedAlleleBFractions

The SegmentedAlleleBFractions class
AromaTabularBinaryFile$allocate

Creates an AromaTabularBinaryFile
getTags.Explorer

Gets the tags of the explorer
display.Explorer

Displays the explorer in the default browser
doCBS

Performs Circular Binary Segmentation (CBS) on a data set
UnitNamesFile

The UnitNamesFile interface class
getParametersAsString.ParametersInterface

Gets the parameters as character
findAnnotationData

Locates an annotation data file
getModel.ChromosomeExplorer

Gets the model
matrixBlockPolish.matrix

Applies a polishing function to blocks of rows and columns repeatedly
getName.AromaTransform

Gets the name of the output data set
getNames.Explorer

Gets the names of the input samples
colBinnedSmoothing.matrix

Binned smoothing of a matrix column by column
mergeBoxplotStats.list

Merges a list of boxplot.stats() elements
getUnitAnnotationDataFile.AromaPlatformInterface

Gets a unit annotation data file of a particular class
findFilesTodo.AromaTransform

Finds files in the data set still not processed
fit.CopyNumberChromosomalModel

Fits the model
processTime

Gets the running time of the R process and its children processes
getCacheKey.CacheKeyInterface

Gets a list of cache key items
colKernelSmoothing.matrix

Kernel smoothing of a matrix column by column
nbrOfArrays.ChromosomalModel

Gets the number of arrays
getCacheKey.FileCacheKeyInterface

Gets a list of cache key items
findAnnotationDataByChipType

Locates an annotation data file by its chip type
indexOf.UnitNamesFile

Gets the indices of units by their names
nbrOfArrays.Explorer

Gets the total number of arrays
getOutputDataSet.AromaTransform

Gets the transformed data set
getRootPath.Explorer

Gets the root path of the output directory
readFooter.AromaTabularBinaryFile

Reads the file footer in XML format into a named nested list
getChipType.AromaPlatformInterface

Gets the chip type
setArrays.Explorer

Sets the arrays
fit.CopyNumberSegmentationModel

Fits the model
segmentByCBS.RawGenomicSignals

Segment copy numbers using the CBS method
isCompatibleWith.AromaPlatformInterface

Checks if a particular unit annotation data file is compatible
getChipType.ChromosomalModel

Gets a label for all chip types merged
getTags.AromaTransform

Gets the tags of the output data set
updateSetupExplorerFile.ChromosomeExplorer

Updates the Javascript file
plotTracks.PairedPSCNData

Plots parental specific copy numbers along the genome
process.AromaTransform

Processes the data set
segmentByGLAD.RawGenomicSignals

Segment copy numbers using the GLAD method
fitGenotypeCone.matrix

Fits an affine transformation to allele A and allele B data
writeDataFrame.AromaUnitSignalBinaryFile

Writes the data file as a tab-delimited text file
writeDataFrame.AromaUnitSignalBinarySet

Writes the data set as a tab-delimited text file
getPath.AromaTransform

Gets the path of the output directory
getChromosomes.ChromosomalModel

Gets the chromosomes to be processed
getPath.Explorer

Gets the path of the output directory
getChromosomes.ChromosomeExplorer

Gets the chromosomes available
isDone.AromaTransform

Checks if the data set is processed or not
getName.Explorer

Gets the name of the explorer
getNames.ChromosomalModel

Gets the names of the arrays
listFiles.AromaRepository

Retrieves the files available on the repository under a particular path
nbrOfChipTypes.AromaMicroarrayDataSetTuple

Gets the number of chip types
process.ChromosomeExplorer

Generates image files, scripts and dynamic pages for the explorer
nbrOfChipTypes.ChromosomalModel

Gets the number of chip types
segmentByHaarSeg.RawGenomicSignals

Segment copy numbers using the HaarSeg method
process.Explorer

Generates image files, scripts and dynamic pages for the explorer
segmentByMPCBS.RawGenomicSignals

Segment copy numbers using the multi-platform CBS (mpCBS) method
writeDataFrame.AromaUnitTabularBinaryFile

Writes the data file as a tab-delimited text file
writeFooter.AromaTabularBinaryFile

Writes a named nested list to the file footer in XML format
setAlias.Explorer

Sets the alias of the output set
setArrays.ChromosomeExplorer

Sets the arrays