-Omics*
-class objectsCreateOmicsPathway.Rd
These functions create valid objects of class OmicsPathway
,
OmicsSurv
, OmicsReg
, or OmicsCateg
.
CreateOmicsPath(assayData_df, sampleIDs_char, pathwayCollection_ls) CreateOmicsSurv( assayData_df, sampleIDs_char, pathwayCollection_ls, eventTime_num, eventObserved_lgl ) CreateOmicsReg( assayData_df, sampleIDs_char, pathwayCollection_ls, response_num ) CreateOmicsCateg( assayData_df, sampleIDs_char, pathwayCollection_ls, response_fact )
assayData_df | An \(N \times p\) data frame with named columns. |
---|---|
sampleIDs_char | A character vector with the N sample names. |
pathwayCollection_ls | A
|
eventTime_num | A |
eventObserved_lgl | A |
response_num | A |
response_fact | A |
A valid object of class OmicsPathway
, OmicsSurv
,
OmicsReg
, or OmicsCateg
.
Please note that the classes of the parameters are not
flexible. The -Omics assay data must be or extend the class
data.frame
, and the response values (for a survival-, regression-,
or categorical-response object) must match their expected classes
exactly. The reason for this is to encourage the end user to pay
attention to the quality and format of their input data. Because the
functions internal to this package have only been tested on the classes
described in the Arguments section, these class checks prevent unexpected
errors (or worse, incorrect computational results without an error). These
draconian input class restrictions protect the accuracy of your data
analysis.
Valid OmicsPathway
objects will have no response information, just the
mass spectrometry or bio-assay ("design") matrix and the pathway list.
OmicsPathway
objects should be created only when unsupervised
pathway extraction is needed (not possible with Supervised PCA). Because of
the missing response, no pathway testing can be performed on an
OmicsPathway
object.
Valid OmicsSurv
objects will have two response vectors: a vector of
the most recently recorded follow-up times and a logical vector if that
time marks an event (TRUE
: observed event; FALSE
: right-
censored observation).
Valid OmicsReg
and OmicsCateg
objects with have one response
vector of continuous (numeric
) or categorial (factor
)
observations, respectively.
OmicsPathway
,
OmicsSurv
,
OmicsReg
, and
OmicsCateg
# DO NOT CALL THESE FUNCTIONS DIRECTLY. USE CreateOmics() INSTEAD. data("colon_pathwayCollection") data("colonSurv_df") if (FALSE) { CreateOmicsPath( assayData_df = colonSurv_df[, -(1:3)], sampleIDs_char = colonSurv_df$sampleID, pathwayCollection_ls = colon_pathwayCollection ) CreateOmicsSurv( assayData_df = colonSurv_df[, -(1:3)], sampleIDs_char = colonSurv_df$sampleID, pathwayCollection_ls = colon_pathwayCollection, eventTime_num = colonSurv_df$OS_time, eventObserved_lgl = as.logical(colonSurv_df$OS_event) ) CreateOmicsReg( assayData_df = colonSurv_df[, -(1:3)], sampleIDs_char = colonSurv_df$sampleID, pathwayCollection_ls = colon_pathwayCollection, response_num = colonSurv_df$OS_time ) CreateOmicsCateg( assayData_df = colonSurv_df[, -(1:3)], sampleIDs_char = colonSurv_df$sampleID, pathwayCollection_ls = colon_pathwayCollection, response_fact = as.factor(colonSurv_df$OS_event) ) }