DistHR {MicrobiomeSurv} | R Documentation |
Null Distribution of the Estimated HR
Description
This function generates the null distribution of the HR by permutation approach either using a large microbiome matrix or a reduced version by supervised pca approach.
Several ways of permutation setting can be implemented.
That is, the function can be used to generate null distributions for four different validation schemes which are PLS based, PCA based, Majority votes based and Lasso based.
Note this function internally calls function SurvPcaClass
, SurvPlsClass
, Majorityvotes
, and Lasoelascox
.
Usage
DistHR(
Survival,
Censor,
Micro.mat,
Prognostic = NULL,
Mean = TRUE,
Quantile = 0.5,
Reduce = FALSE,
Select = 5,
nperm = 100,
case = 2,
Method = "BH",
Validation = c("PLSbased", "PCAbased", "L1based", "MVbased")
)
Arguments
Survival |
A vector of survival time with length equals to number of subjects. |
Censor |
A vector of censoring indicator. |
Micro.mat |
A large or small microbiome profile matrix. A matrix with microbiome profiles where the number of rows should be equal to the number of taxa and number of columns should be equal to number of patients. |
Prognostic |
A dataframe containing possible prognostic(s) factor and/or treatment effect to be used in the model. |
Mean |
The cut off value for the classifier, default is the mean cutoff. |
Quantile |
If user want to use quantile as cutoff point. They need to specify Mean = FALSE and a quantile that they want to use. The default is the median cutoff. |
Reduce |
A boolean parameter indicating if the microbiome profile matrix should be reduced, default is TRUE and larger microbiome profile matrix is reduced by supervised pca approach and first pca is extracted from the reduced matrix to be used in the classifier. |
Select |
Number of taxa (default is 5) to be selected from supervised PCA. This is valid only if the argument Reduce=TRUE. |
nperm |
Number of permutations to be used and default 100. |
case |
There are seven different ways on how to call this argument:
|
Method |
A multiplicity adjustment Method that user can choose. The default is BH Method. |
Validation |
There are four different validation schemes where the null distribution can be estimated. That is c("PLSbased","PCAbased","L1based","MVbased"). |
Value
A object of class perm
is returned with the following values
HRobs |
Estimated HR for low risk group on the original data. |
HRperm |
Estimated HR for low risk group on the permuted data. |
nperm |
Number of permutations carried out. |
Validation |
The validation scheme that was used. |
Author(s)
Thi Huyen Nguyen, thihuyen.nguyen@uhasselt.be
Olajumoke Evangelina Owokotomo, olajumoke.x.owokotomo@gsk.com
Ziv Shkedy
See Also
coxph
, EstimateHR
, SurvPcaClass
, SurvPlsClass
, Majorityvotes
, Lasoelascox
Examples
# Prepare data
data(Week3_response)
Week3_response = data.frame(Week3_response)
surv_fam_shan_w3 = data.frame(cbind(as.numeric(Week3_response$T1Dweek),
as.numeric(Week3_response$T1D)))
colnames(surv_fam_shan_w3) = c("Survival", "Censor")
prog_fam_shan_w3 = data.frame(factor(Week3_response$Treatment_new))
colnames(prog_fam_shan_w3) = c("Treatment")
data(fam_shan_trim_w3)
names_fam_shan_trim_w3 =
c("Unknown", "Lachnospiraceae", "S24.7", "Lactobacillaceae", "Enterobacteriaceae", "Rikenellaceae")
fam_shan_trim_w3 = data.matrix(fam_shan_trim_w3[ ,2:82])
rownames(fam_shan_trim_w3) = names_fam_shan_trim_w3
# Using the function
DistHR_fam_shan_w3 = DistHR(Survival = surv_fam_shan_w3$Survival,
Micro.mat = fam_shan_trim_w3,
Censor = surv_fam_shan_w3$Censor,
Prognostic=prog_fam_shan_w3,
Mean = TRUE,
Quantile=0.5,
Reduce= FALSE,
Select = 5,
nperm=100,
case=4,
Method = "BH",
Validation="PCAbased")
# Method that can be used for the result
show(DistHR_fam_shan_w3)
summary(DistHR_fam_shan_w3)
plot(DistHR_fam_shan_w3)