Learn R Programming

beadplexr

Reproducible and easy analysis and evaluation of LEGENDplex, CBA, and MACSPlex experiments.

The companies behind the above beadplex systems, provide their own software for the analysis of the generated data. However, the strong dependence on manual interaction make the respective solutions labor-intensive and above all not always reproducible.

Installation

From CRAN:

install.packages("beadplexr")

Or the development version from GitLab:

# install.packages("devtools")
devtools::install_git("https://gitlab.com/ustervbo/beadplexr")
#
# Or with vignettes built
# devtools::install_git("https://gitlab.com/ustervbo/beadplexr", build_vignettes = TRUE)

beadplexr depends on several packages with system requirements. On an Unix/Linux system the libraries can be installed with

sudo apt install \
    libnlopt-dev \
    libfontconfig1-dev \
    libharfbuzz-dev libfribidi-dev \
    libfreetype6-dev libpng-dev libtiff5-dev libjpeg-dev

For other systems, please see the documentation of the individual packages:

  • nloptr (needs libnlopt-dev)
  • systemfonts (needs libfontconfig1-dev)
  • textshaping (needs libharfbuzz-dev libfribidi-dev)
  • ragg (needs libfreetype6-dev libpng-dev libtiff5-dev libjpeg-dev)

Getting started

library(beadplexr)

The package comes with a comprehensive example in the vignette 'Analysis of LEGENDplex data with beadplexr':

vignette("legendplex_analysis", package = "beadplexr")

Citing the package

Please cite as:

Stervbo U, Westhoff TH, Babel N (2018). "beadplexr: Reproducible and automated analysis of multiplex bead assays." PeerJ, 6, e5794. ISSN 2167-8359, doi: 10.7717/peerj.5794

Get the reference BibTex format here.

Copy Link

Version

Install

install.packages('beadplexr')

Monthly Downloads

226

Version

0.5.0

License

MIT + file LICENSE

Maintainer

Ulrik Stervbo

Last Published

June 16th, 2023

Functions in beadplexr (0.5.0)

fit_standard_curve

Fit a standard curve
do_find_turning_points

Find turning points
:=

Walrus operator
lplex

LEGENDplex example data
load_panel

Load panel information
panel_name_file

Get file name from panel name
trim_population

Trim cluster.
read_fcs

Read a fcs file.
turning_point

Turning points
plot_concentrations

Plot concentrations
simplex

Simulated beadplex data
identify_analyte

Identify analyte
identify_assay_analyte

Identify multiplex assay analytes
pad_matrix

Pad a matrix
raise_deprecated

Warn about deprecated parameters or functions
approx_adjust

Approximate bandwidth adjustment.
cluster_events

Clustering with trimming
calc_centre

Calculate population center
calc_std_conc

Calculate standard concentration
as_data_frame_analyte

Cast list of analytes to data.frame
assign_analyte_id

Assign analyte ID
dist_chebyshev

Chebyshev distance
calc_dist_to_centre

Calculate euclidean distance between two points.
geometric_mean

Calculate geometric mean
count_neighbours

Count neighbours for each element in a binary matrix
calculate_concentration

Calculate concentration.
get_col_names_args

Get column names from the method arguments
harmonic_mean

Calculate harmonic mean
ident_bead_pop

Identify bead populations
density_cut

Density cut.
calc_analyte_mfi

Calculate the analyte intensity
facs_plot

Plot FACS data.
despeckle

Despeckle parameters