Changes in version 2.1.5 ( Release date: 2018-06-28)
Changes:
- Add functionality to
getBestFeatures
to allowedgeR
for DE, as well as weights used withedgeR
forzinbwave
compatability. As part of this change:- Removed
isCount
argument and replaced with more fine-grainedDEMethod
argument ingetBestFeatures
,mergeClusters
; ormergeDEMethod
inRSEC
. - Change to class definition: added slot
merge_demethod
to keep track of the DE method used in merging
- Removed
- Change function names (old function name is now depricated):
combineMany
->makeConsensus
removeUnclustered
->removeUnassigned
- Arguments to functions changed:
combineProportion
->consensusProportion
inRSEC
combineMinSize
->consensusMinSize
inRSEC
sampleData
->colData
to matchSummarizedExperiment
syntax (in many plotting functions).alignSampleData
->alignColData
inplotHeatmap
ignoreUnassignedVar
->filterIgnoresUnassigned
inmergeClusters
(and other functions) for clarity.removeNegative
->removeUnassigned
ingetBestFeatures
for uniformity- Removed
largeDataset
option tosubsampleClustering
because no longer provides advantage. nBlank
->nBlankFeatures
inmakeBlankData
to allow for samples
- Created functions:
primaryClusterLabel
andprimaryClusterType
getReducedData
assignUnassigned
: assigns unassigned samples to nearest clusterrenameClusters
andrecolorClusters
: assign new names/colors to clusters within a particular clustering
clusterMatrixColors
: wrapper toconvertClusterLegend
to return matrix likeclusterMatrix
only with colors in place of the internal cluster ids (like existingclusterMatrixNamed
)plotClustersTable
for plotting a heatmap showing the results oftableClusters
subsetByCluster
for subsetting CE object to only those samples in a particular cluster(s) of a clustering.plotFeatureScatter
for a scatter plot of 2+ features (genes) colored by clusteraddToColData
andcolDataClusters
adding clustering information to colData of object.addToColData
returns object withcolData
augmented, whilecolDataClusters
just returns theDataFrame
with clusterings added.updateObject
to update historical object created from previous versions to the current class definitions.
- Added arguments:
whichAssay
to all functions to allow the user to select the assay on which the operations will be performed.stopOnErrors
toRSEC
nColLegend
toplotReducedDims
subsample
andsequential
toRSEC
to allow for opting out of those options (but default isTRUE
unlikeclusterMany
)nBlankSamples
andgroupsOfSamples
tomakeBlankData
to allow for separating samples (columns)add
andlocation
toplotClusterLegend
makeBlankData
will now allow for making blank columns to separate groups of samples.plotDendrogram
now allows for plotting ofcolData
(previouslysampleData
) likeplotHeatmap
orplotClusters
clusterMany
now allows user-definedClusterFunction
objects to argumentclusterFunction
.- Removed restriction in
plotClustersWorkflow
that onlyclusterType="clusterMany"
allowed. - Allow
getClusterManyParams
to search oldclusterMany
runs as well. - Added
table
method toplotHeatmap
(for plotting heatmap of results oftable
function) - Added error catch if try to give argument
whichCluster
tomergeCluster
. - Added error catch if give param
whichClusters
to functions that only takewhichCluster
(singular) as an argument plotFeatureBoxplot
now returns (invisibly) the colors and clusterIds along with the boxplot information.
Bugs:
- Add check for merge_nodeMerge table that
mergeClusterId
column can't be NA for entries whereisMerged=TRUE
- Fix internal .makeIntegerClusters so that if given values
1:K
for input clustering will retain these same values (Issue #227) mergeClusters
now returned object saves the merge information (and deletes old info and updates clusterType/clusterLabel of existing merge clusters), even ifmergeMethod="none"
.- Fix
removeClusterings
so doesn't loose merge info unless deleting relevant clusterings.