create_comparisonDF {pmartR}

Returns data frame with comparisons to be made

Description

The method creates a data frame containing the comparisons to be made when performing differential statistics.

Usage

create_comparisonDF(comp_type, omicsData, control_group = NULL)

Arguments

comp_type

string specifying either "control" or "pairwise". Specifying "control" indicates that all other groups are to be compared to a single control group. Specifying "pairwise" indicates that all pairwise comparisons are to be made.

omicsData

A pmartR data object of any class, which has a 'group_df' attribute created by the 'group_designation()' function

control_group

string indicating the group to use for the control group. Only required when comp_type="control".

Details

This function takes in the omicsData and type of comparison, and returns a data frame where each row corresponds to a comparison of interest.

Value

data frame with columns for Test and Control. Each row corresponds to a comparison of interest.

Author(s)

Kelly Stratton

See Also

group_designation

Examples

library(pmartRdata)
mymetab <- group_designation(omicsData = metab_object, main_effects = "Phenotype")
create_comparisonDF(comp_type = "pairwise", omicsData = mymetab)

create_comparisonDF(comp_type = "control", omicsData = mymetab, control_group = "Phenotype1")