addItem {DGEobj}R Documentation

Add a data item

Description

Add a data item

Usage

addItem(
  dgeObj,
  item,
  itemName,
  itemType,
  funArgs = match.call(),
  itemAttr,
  parent = "",
  overwrite = FALSE,
  init = FALSE
)

Arguments

dgeObj

A class DGEobj created by function initDGEobj()

item

The data item to be deposited in the DGEobj

itemName

The user-assigned name for this data item

itemType

The type attribute. See showTypes() to see the predefined types – types are extensible with the newType() function.

funArgs

(optional) A text field to annotate how the data object was created. If the result of match.call() is passed as this argument, the name and arguments used in the current function are captured

itemAttr

(optional) A named list of attributes to add directly to the item

parent

(optional) itemName of the parent of this item

overwrite

Whether to overwrite a matching data object stored in the itemName slot (default = FALSE)

init

Internal Use (default = FALSE)

Value

A DGEobj

Examples

## Not run: 
   myFunArgs <- match.call()  #  Capture calling function and arguments

   myDGEobj <- addItem(myDGEobj, item = MyCounts,
                                 itemName = "counts",
                                 itemType = "counts",
                                 funArgs = myFunArgs)

## End(Not run)


[Package DGEobj version 1.0.3 Index]