rsecFluidigm: Documentation of rsecFluidigm object
In epurdom/clusterExperiment: Compare Clusterings for Single-Cell Sequencing

rsecFluidigm

R Documentation

Documentation of rsecFluidigm object

Description

Documentation of the creation of rsecFluidigm, result of RSEC run on fluidigm data for vignette

Usage

makeRsecFluidigmObject(object)

Arguments

object

object given to functions

Format

rsecFluidigm is a ClusterExperiment object, the result of running RSEC on fluidigm data described in vignette and available in the scRNAseq package.

Details

The functions makeRsecFluidigmObject and checkRsecFluidigmObject are helper functions whose sole purpose is to create rsecFluidigm and check that the results are the same as expected. makeRsecFluidigmObject also serves as documentation of the specific RSEC call that was made to create the rsecFluidigm object, as well as filtering and normalization of the fluidigm data. The purpose of making them functions is internal, to help more easily mantain and check if changes to the package have affected the results.

Author(s)

Elizabeth Purdom epurdom@stat.berkeley.edu

Examples

# see code used create rsecFluidigm 
# (print out the function)
makeRsecFluidigmObject
#code actualy run to create rsecFluidigm:
## Not run: 
library(clusterExperiment)
data(fluidigmData)
data(fluidigmColData)
se<-SummarizedExperiment(assays=fluidigmData, colData=fluidigmColData)
RNGversion("3.5.0")
rsecFluidigm<-makeRsecFluidigmObject(se)
# Internal function for checking got correct results...
clusterExperiment:::checkRsecFluidigmObject(rsecFluidigm)
usethis::use_data(rsecFluidigm,overwrite=FALSE)

## End(Not run)

epurdom/clusterExperiment documentation built on April 28, 2024, 8:17 p.m.