Description Usage Arguments Value
View source: R/data_preparation.R
This functions prepares Illumina BeadChip data for a MeDeCom run.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | prepare_data(RNB_SET, WORK_DIR = getwd(), analysis.name = "analysis",
SAMPLE_SELECTION_COL = NA, SAMPLE_SELECTION_GREP = NA,
PHENO_COLUMNS = NA, ID_COLUMN = rnb.getOption("identifiers.column"),
NORMALIZATION = "none", REF_CT_COLUMN = NA, REF_RNB_SET = NULL,
REF_RNB_CT_COLUMN = NA, PREPARE_TRUE_PROPORTIONS = FALSE,
TRUE_A_TOKEN = NA, HOUSEMAN_A_TOKEN = NA,
ESTIMATE_HOUSEMAN_PROP = FALSE,
FILTER_BEADS = !is.null(RNB_SET@covg.sites), MIN_N_BEADS = 3,
FILTER_INTENSITY = inherits(RNB_SET, "RnBeadRawSet"),
MIN_INT_QUANT = 0.01, MAX_INT_QUANT = 0.99, FILTER_NA = TRUE,
FILTER_CONTEXT = TRUE, FILTER_SNP = TRUE, FILTER_SOMATIC = TRUE,
FILTER_CROSS_REACTIVE = T, remove.ICA = F, conf.fact.ICA = NULL,
ica.setting = NULL, snp.list = NULL, execute.lump = FALSE,
dist.snps = FALSE)
|
RNB_SET |
An object of type |
WORK_DIR |
A path to a existing directory, in which the results are to be stored |
analysis.name |
A string representing the dataset for which analysis is to be performed. Only used to create a folder with a descriptive name of the analysis. |
SAMPLE_SELECTION_COL |
A column name in the phenotypic table of |
SAMPLE_SELECTION_GREP |
A string used for selecting samples in the column |
PHENO_COLUMNS |
Vector of column names in the phenotypic table of |
ID_COLUMN |
Sample-specific ID column name in |
NORMALIZATION |
Normalization method to be performed before employing MeDeCom. Can be one of |
REF_CT_COLUMN |
Column name in |
REF_RNB_SET |
An object of type |
REF_RNB_CT_COLUMN |
Column name in |
PREPARE_TRUE_PROPORTIONS |
Flag indicating if true proportions are either available in |
TRUE_A_TOKEN |
String present in the column names of |
HOUSEMAN_A_TOKEN |
Similar to |
ESTIMATE_HOUSEMAN_PROP |
If neither |
FILTER_BEADS |
Flag indicating, if site-filtering based on the number of beads available is to be conducted. |
MIN_N_BEADS |
Minimum number of beads required in each sample for the site to be considered for adding to MeDeCom. |
FILTER_INTENSITY |
Flag indicating if sites should be removed according to the signal intensities (the lowest and highest quantiles
given by |
MIN_INT_QUANT |
Lower quantile of intensities which is to be removed. |
MAX_INT_QUANT |
Upper quantile of intensities which is to be removed. |
FILTER_NA |
Flag indicating if sites with any missing values are to be removed or not. |
FILTER_CONTEXT |
Flag indicating if only CG probes are to be kept. |
FILTER_SNP |
Flag indicating if annotated SNPs are to be removed from the list of sites according to RnBeads' SNP list. Or as the sites
specified in |
FILTER_SOMATIC |
Flag indicating if only somatic probes are to be kept. |
FILTER_CROSS_REACTIVE |
Flag indicating if sites showing cross reactivity on the array are to be removed. |
remove.ICA |
Flag indicating if independent component analysis is to be executed to remove potential confounding factor.
If |
conf.fact.ICA |
A vector of column names in the sample annotation sheet representing potential confounding factors. |
ica.setting |
Named vector of settings passed to run.rnb.ica. Options are |
snp.list |
Path to a file containing CpG IDs of known SNPs to be removed from the analysis, if |
execute.lump |
Flag indicating if the LUMP algorithm is to be used for estimating the amount of immune cells in a particular sample. |
dist.snps |
Flag indicating if SNPs are to removed by determining if the pairwise differences between the CpGs in the samples are trimodally distributed as it is frequently found around SNPs. |
A list with four elements:
quality.filter The indices of the sites that survived quality filtering
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.