getInitiationInfo: Obtain information about object initiation

View source: R/getH-M.R

getInitiationInfoR Documentation

Obtain information about object initiation

Description

Information about the object's initiation is stored in a list of three slots:

  • init_fn: Contains the name of the initation function as a character value.

  • input: Contains a list of which every slot refers to the input of one argument with which the initiation function has been called.

  • time: Contains the time at which the object was initiated.

getInitiationInput() returns only slot input.

Usage

getInitiationInfo(object)

getInitiationInput(object, verbose = NULL)

Arguments

object

A valid spata-object.

verbose

Logical. If set to TRUE informative messages regarding the computational progress will be printed.

(Warning messages will always be printed.)

Details

initiateSpataObject_CountMtr() and initiateSpataObject_ExprMtr() each require a matrix and a coordinate data.frame as input. These are not included in the output of this function but can be obtained via getCoordsDf() and getCountMtr() or getExpressionMtr().

Value

A list. See description.


kueckelj/SPATA2 documentation built on March 16, 2024, 10:25 a.m.