Note: This function, as all get functions from this package, does NOT return a GRN object.

getParameters(GRN, type = "parameter", name = "all")

Arguments

GRN

Object of class GRN

type

Character. Either function or parameter. Default parameter. When set to function, a valid GRaNIE function name must be given that has been run before. When set to parameter, in combination with name, returns a specific parameter (as specified in GRN@config)).

name

Character. Default all. Name of parameter or function name to retrieve. Set to the special keyword all to retrieve all parameters.

Value

The requested parameters. This function does **NOT** return a GRN object.

Examples

# See the Workflow vignette on the GRaNIE website for examples
GRN = loadExampleObject()
#> Downloading GRaNIE example object from https://git.embl.de/grp-zaugg/GRaNIE/-/raw/master/data/GRN.rds
#> INFO [2023-12-10 14:47:11] Storing GRN@data$RNA$counts matrix as sparse matrix because fraction of 0s is > 0.1 (0.44)
#> Finished successfully. You may explore the example object. Start by typing the object name to the console to see a summaty. Happy GRaNIE'ing!
params.l = getParameters(GRN, type = "parameter", name = "all")