- experiment_dat
A SummarizedExperiment object containing microbiome data and covarites (see example on how to create a SummarizedExperiment object). The microbiome data can be absolute abundance or relative abundance
with each column per sample and each row per taxon/OTU/ASV (or any other unit). No imputation is needed for zero-valued data points. The covarites data contains covariates and confounders with each row per sample and each
column per variable. The covarites data has to be numeric or binary.
- testCov
Covariates that are of primary interest for testing and estimating the associations. It corresponds to $X_i$ in the equation. Default is NULL
which means all covariates are testCov
.
- ctrlCov
Potential confounders that will be adjusted in the model. It corresponds to $W_i$ in the equation. Default is NULL
which means all covariates except those in testCov
are adjusted as confounders.
- sampleIDname
Name of the sample ID variable in the data. In the case that the data does not have an ID variable, this can be ignored. Default is NULL.
- testMany
This takes logical value TRUE
or FALSE
. If TRUE
, the testCov
will contain all the variables in CovData
provided testCov
is set to be NULL
. The default value is TRUE
which does not do anything if testCov
is not NULL
.
- ctrlMany
This takes logical value TRUE
or FALSE
. If TRUE
, all variables except testCov
are considered as control covariates provided ctrlCov
is set to be NULL
. The default value is FALSE
.
- nRef
The number of randomly picked reference taxa used in phase 1. Default number is 40
.
- nRefMaxForEsti
The maximum number of final reference taxa used in phase 2. The default is 2
.
- refTaxa
A vector of taxa or OTU or ASV names. These are reference taxa specified by the user to be used in phase 1. If the number of reference taxa is less than 'nRef', the algorithm will randomly pick extra reference taxa to make up 'nRef'. The default is NULL
since the algorithm will pick reference taxa randomly.
- adjust_method
The adjusting method for p value adjustment. Default is "BY" for dependent FDR adjustment. It can take any adjustment method for p.adjust function in R.
- fdrRate
The false discovery rate for identifying taxa/OTU/ASV associated with testCov
. Default is 0.15
.
- paraJobs
If sequentialRun
is FALSE
, this specifies the number of parallel jobs that will be registered to run the algorithm. If specified as NULL
, it will automatically detect the cores to decide the number of parallel jobs. Default is NULL
.
- bootB
Number of bootstrap samples for obtaining confidence interval of estimates in phase 2 for the high dimensional regression. The default is 500
.
- standardize
This takes a logical value TRUE
or FALSE
. If TRUE
, the design matrix for X will be standardized in the analyses and the results. Default is FALSE
.
- sequentialRun
This takes a logical value TRUE
or FALSE
. Default is FALSE
. This argument could be useful for debug.
- refReadsThresh
The threshold of proportion of non-zero sequencing reads for choosing the reference taxon in phase 2. The default is 0.2
which means at least 20% non-zero sequencing reads.
- taxDropThresh
The threshold of number of non-zero sequencing reads for each taxon to be dropped from the analysis. The default is 0
which means taxon without any sequencing reads will be dropped from the analysis.
- SDThresh
The threshold of standard deviations of sequencing reads for been chosen as the reference taxon in phase 2. The default is 0.05
which means the standard deviation of sequencing reads should be at least 0.05
in order to be chosen as reference taxon.
- SDquantilThresh
The threshold of the quantile of standard deviation of sequencing reads, above which could be selected as reference taxon. The default is 0
.
- balanceCut
The threshold of the proportion of non-zero sequencing reads in each group of a binary variable for choosing the final reference taxa in phase 2. The default number is 0.2
which means at least 20% non-zero sequencing reads in each group are needed to be eligible for being chosen as a final reference taxon.
- verbose
Whether the process message is printed out to the console. The default is TRUE.
- seed
Random seed for reproducibility. Default is 1
. It can be set to be NULL to remove seeding.