Description Usage Arguments Details Value Author(s) Examples
View source: R/facopy_internal_v45.r
Main function in the facopy package. It performs statistical association between copy number data and further variables at each genomic feature of interest.
1 2 3 4 5 6 7 | facopy(fad, alteration, model, nullModel = NULL,
modelPart = c("response","predictor","unknown","whole")[1],
strata = NULL, toOrdered = NULL, toIntervals = NULL,
sel = NULL, plot = FALSE, pvalThr = 0.05, db = NULL,
link = c("logit", "probit")[1], parametric = FALSE,
design = c("binary", "versus", "lvog")[1],
FUN, ...)
|
fad |
|
alteration |
A character, the name of the combination of alterations to be considered for the analysis. |
model |
A character. Model, or part of it (response or predictor), whose association will be measured. |
nullModel |
A character. The null model against which to evaluate the fitness of the association model. Only used if |
modelPart |
A character. Indicates what part of the association model is defined in the |
strata |
A character. The name of a categorical variable that defines stratification blocks in the association model. Only used if |
toOrdered |
Certain categorical variables can also be understood as ordered. This parameter takes a list of named vectors, where the name of each vector is a variable name and its contents reflect the quantification of the variable values, in the same order as defined in |
toIntervals |
Quantitative variables can be broken down into intervals. This parameter takes a list of named vectors, where the name of each vector is a variable name and its contents reflect the breaks of the variable values (excluding bottom and top limits). |
sel |
A vector of feature names on which to perform the association. Leave to |
plot |
A logicil indicating whether to output a composite plot with an arm-wise display of genome-wide alteration frequencies. If the model consists of a single variable, frequencies will be broken down by variable value. Features with significant associations and additional information pulled from external databases can be displayed as overlaid layers. |
pvalThr |
Significant associations under this threshold will be shaded in the output plot. Only used if |
db |
An optional string representing the name of a database whose data will be overlaid in the output plot. Typically, the format is "[ |
link |
A character, link function to be used with the multinomial error distribution in logistic regression models. See |
parametric |
A logical that indicates whether to perform one-way ANOVA instead of Kruskal-Wallis in the association of copy number with quantitative variables. |
design |
Depending on the chosen alteration, different designs are available. The simplest design is |
FUN |
A function that tests a model. Only used if |
... |
Further arguments for the |
Only the facopyInfo
object, the alteration type and a simple model (e.g. the name of a variable) are required. The rest of the parameters tune up the association model and control the graphical output.
Alterations in the selected external database, if selected, are depicted as grey overlaid bars. Significant regions are depicted in turn as overlaid rectangles that go from top to bottom.
A data.frame
with the following columns:
feature |
Name of the genomic feature. |
p_value |
Pvalue from the association test under the given model at the genomic feature. |
chr_q_arm |
Chromosome and arm in which the genomic feature lies. |
bp_st |
Starting genomic position of the feature within the chromosome. |
bp_en |
Ending genomic position of the feature within the chromosome. |
David Mosen-Ansorena
1 2 3 4 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.