Description Arguments Details Section
The proBatch package contains functions for analyzing and correcting batch effects (unwanted technical variation) from high-thoughput experiments. Although the package has primarily been developed for mass spectrometry proteomics (DIA/SWATH), it has been designed be applicable to most omic data with minor adaptations. It addresses the following needs:
prepare the data for analysis
Visualize batch effects in sample-wide and feature-level;
Normalize and correct for batch effects.
df_long |
data frame where each row is a single feature in a single
sample. It minimally has a |
data_matrix |
features (in rows) vs samples (in columns) matrix, with
feature IDs in rownames and file/sample names as colnames.
See "example_proteome_matrix" for more details (to call the description,
use |
sample_annotation |
data frame with:
.
See |
sample_id_col |
name of the column in |
measure_col |
if |
feature_id_col |
name of the column with feature/gene/peptide/protein
ID used in the long format representation |
batch_col |
column in |
order_col |
column in |
facet_col |
column in |
color_by_batch |
(logical) whether to color points and connecting lines
by batch factor as defined by |
peptide_annotation |
long format data frame with peptide ID and their
corresponding protein and/or gene annotations.
See |
color_scheme |
a named vector of colors to map to |
color_list |
list, as returned by |
factors_to_plot |
vector of technical and biological covariates to be
plotted in this diagnostic plot (assumed to be present in
|
protein_col |
column where protein names are specified |
no_fit_imputed |
(logical) whether to use imputed (requant) values, as flagged in
|
qual_col |
column to color point by certain value denoted
by |
qual_value |
value in |
plot_title |
title of the plot (e.g., processing step + representation level (fragments, transitions, proteins) + purpose (meanplot/corrplot etc)) |
keep_all |
when transforming the data (normalize, correct) - acceptable values: all/default/minimal (which set of columns be kept). |
theme |
ggplot theme, by default |
filename |
path where the results are saved. If null the object is returned to the active window; otherwise, the object is save into the file. Currently only pdf and png format is supported |
width |
option determining the output image width |
height |
option determining the output image width |
units |
units: 'cm', 'in' or 'mm' |
To learn more about proBatch, start with the vignettes:
browseVignettes(package = "proBatch")
Common arguments to the functions.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.