View source: R/initiateSpataObject.R
initiateSpataObject_Examples | R Documentation |
spata2
object from example data setsCreates and returns an object of class spata from the example data sets provided by the package SeuratData. See details for more.
initiateSpataObject_Examples(
data_set = "stxBrain",
type = "anterior1",
force = FALSE,
gene_set_path = NULL,
SCTransform = FALSE,
NormalizeData = list(normalization.method = "LogNormalize", scale.factor = 1000),
FindVariableFeatures = list(selection.method = "vst", nfeatures = 2000),
ScaleData = TRUE,
RunPCA = list(npcs = 60),
FindNeighbors = list(dims = 1:30),
FindClusters = list(resolution = 0.8),
RunTSNE = TRUE,
RunUMAP = list(dims = 1:30),
verbose = TRUE
)
data_set |
Character value. The data-set from which to create the |
type |
Given to argument |
force |
Logical. If set to TRUE, the function installs all requirements (packages, data sets) automatically without requesting any further permission. If set to FALSE, the function stops with an informative error message when it encounters missing installations. |
gene_set_path |
Character value (or NULL). Specifies the path to a .RDS-file containing a data.frame that is to be used as input for slot @used_genesets. Must have the character-variables
If set to NULL the default gene-set data.frame will used. Run |
SCTransform |
A named list of arguments given to |
NormalizeData |
A named list of arguments given to |
FindVariableFeatures |
A named list of arguments given to |
ScaleData |
A named list of arguments given to Hint: If set to TRUE or the argument-list provided does not specify the argument |
RunPCA |
A named list of arguments given to |
FindNeighbors |
A named list of arguments given to |
FindClusters |
A named list of arguments given to |
RunTSNE |
A named list of arguments given to |
RunUMAP |
A named list of arguments given to |
verbose |
Logical. If set to TRUE informative messages regarding the computational progress will be printed. (Warning messages will always be printed.) |
The loading and preprocessing of the spata2
object currently relies on the Seurat-package. Before any pre processing function is applied
mitochondrial and stress genes are discarded. For more advanced users the arguments above starting with a capital letter allow to
manipulate the way the spata2
object is processed. For all of these arguments apply the following instructions:
If set to FALSE the processing function is skipped.
If set to TRUE the respective function is called with it's default argument settings. Note: RunUMAP()
needs
additional input!
If a named list is provided the respective function is called whereby the named list will provide the argument-input (the Seurat
object to be constructed must not be named and will be
passed to every function as the first argument!!!.)
Note that certain listed functions require previous functions! E.g. if RunPCA
is set to FALSE RunTSNE()
will result in an error. (base::tryCatch()
will prevent the function from crashing but the respective slot
is going to be empty.) Skipping functions might result in an incomplete spata2
object. Use validateSpataObject()
after
initiating it in order to see which slots are valid and which are not.
A spata2
object.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.