Description Usage Arguments Details Value See Also Examples
"Get" or "Set" the values of the assayData_df
,
sampleIDs_char
, or pathwayCollection
slots of an object of
class OmicsPathway
or a class that extends this class
(OmicsSurv
, OmicsReg
, or OmicsCateg
).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | getAssay(object, ...)
getAssay(object) <- value
getSampleIDs(object, ...)
getSampleIDs(object) <- value
getPathwayCollection(object, ...)
getPathwayCollection(object) <- value
getTrimPathwayCollection(object, ...)
## S4 method for signature 'OmicsPathway'
getAssay(object, ...)
## S4 replacement method for signature 'OmicsPathway'
getAssay(object) <- value
## S4 method for signature 'OmicsPathway'
getSampleIDs(object, ...)
## S4 replacement method for signature 'OmicsPathway'
getSampleIDs(object) <- value
## S4 method for signature 'OmicsPathway'
getPathwayCollection(object, ...)
## S4 replacement method for signature 'OmicsPathway'
getPathwayCollection(object) <- value
## S4 method for signature 'OmicsPathway'
getTrimPathwayCollection(object, ...)
|
object |
An object of or extending |
... |
Dots for additional internal arguments (currently unused). |
value |
The replacement object to be assigned to the specified slot. |
These functions can be useful to set or extract the assay data or
pathways list from an Omics*
-class object. However, we recommend
that users simply create a new, valid Omics*
object instead of
modifying an existing one. The validity of edited objects is checked with
the ValidOmicsSurv
, ValidOmicsCateg
, or
ValidOmicsReg
functions.
Further, because the pathwayPCA
methods require a cleaned (trimmed)
pathway collection, the trimPathwayCollection
slot is read-only.
Users may only edit this slot by updating the pathway collection provided
to the pathwayCollection
slot. Despite this functionality, we
strongly recommend that users create a new object with the
updated pathway collection, rather than attempting to overwrite the slots
within an existing object. See IntersectOmicsPwyCollct
for
details on trimmed pathway collection.
The "get" functions return the objects in the slots specified:
getAssay
returns the assayData_df
data frame object,
getSampleIDs
returns the sampleIDs_char
character vector,
getPathwayCollection
returns the pathwayCollection
list
object, and getTrimPathwayCollection
returns the
trimPathwayCollection
. These functions can extract these values
from any valid OmicsPathway
, OmicsSurv
, OmicsReg
, or
OmicsCateg
object.
The "set" functions enable the user to edit or replace objects in the
assayData_df
, sampleIDs_char
, or pathwayCollection
slots for any OmicsPathway
, OmicsSurv
, OmicsReg
, or
OmicsCateg
objects, provided that the new values do not violate
the validity checks of their respective objects. Because the slot for
trimPathwayCollection
is filled upon object creation, and to ensure
that this pathway collection is "clean", there is no "set" function for
the trimmed pathway collection slot. Instead, users can update the pathway
collection, and the trimmed pathway collection will be updated
automatically. See "Details" for more information on the "set" functions.
1 2 3 4 5 6 7 8 9 10 | data("colonSurv_df")
data("colon_pathwayCollection")
colon_Omics <- CreateOmics(
assayData_df = colonSurv_df[, -(2:3)],
pathwayCollection_ls = colon_pathwayCollection
)
getAssay(colon_Omics)
getPathwayCollection(colon_Omics)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.