Skip to content
cccskills
FreePublished on GitHub

bioconductor-phipdata

PhIPData defines an S4 class for phage-immunoprecipitation sequencing (PhIP-seq) experiments. Buliding upon the RangedSummarizedExperiment class, PhIPData enables users to coordinate metadata with experimental data in analyses. Additionally, PhIPData provides specialized methods to subset and identify beads-only samples, subset objects using virus aliases, and use existing peptide libraries to populate object parameters.

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md5.3 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

PhIPData

Workflows

Standard Workflow

PhIPData defines an S4 class for phage-immunoprecipitation sequencing (PhIP-seq) experiments. Buliding upon the RangedSummarizedExperiment class, PhIPData enables users to coordinate metadata with experimental data in analyses. Additionally, PhIPData provides specialized methods to subset and identify beads-only samples, subset objects using virus aliases, and use existing peptide libraries to populate object parameters.

library(PhIPData)

# 1. Define dimensions and simulate data matrices
n_samples <- 5L
n_peps <- 10L
counts_dat <- matrix(sample(1:1e6, n_samples*n_peps, replace = TRUE), nrow = n_peps)
logfc_dat <- matrix(rnorm(n_samples*n_peps, mean = 0, sd = 10), nrow = n_peps)
prob_dat <- matrix(rbeta(n_samples*n_peps, shape1 = 1, shape2 = 1), nrow = n_peps)

# 2. Define metadata
peptide_meta <- data.frame(pep_id = paste0("pep_", 1:n_peps))
sample_meta <- data.frame(
  sample_name = paste0("sample", 1:n_samples), 
  group = c("ctrl", "beads", "trt", "trt", "trt")
)

# 3. Construct PhIPData object and subset beads-only samples
phip_obj <- PhIPData(counts_dat, logfc_dat, prob_dat, peptide_meta, sample_meta)
beads_only <- subsetBeads(phip_obj)

Note: Inputs are parallel matrices of counts, log fold-changes, probabilities, and metadata data frames; output is a coordinated PhIPData object.

When to Use

  • Storing PhIP-seq experimental results: Manage raw read counts, log2 estimated fold-changes, and enrichment probabilities in a single coordinated container.
  • Identifying and subsetting control samples: Quickly isolate beads-only control samples using the specialized subsetBeads() wrapper.
  • Managing peptide libraries and virus aliases: Query and subset specific viral species using setAlias(), getAlias(), and standard subset() operations.

When NOT to Use

  • For general RNA-seq differential expression: Use DESeq2 or edgeR because PhIPData is specifically tailored for PhIP-seq antibody enrichment assays.
  • For single-cell transcriptomics: Use SingleCellExperiment because PhIPData is designed for bulk phage-display sequencing experiments.
  • For mass spectrometry-based proteomics: Use QFeatures or MSnbase because PhIPData is designed for high-throughput sequencing of phage libraries.

Data Requirements

  • Assay Matrices: Three parallel matrices of identical dimensions: counts (non-negative numeric values), logfc (log2 estimated fold-changes), and prob (enrichment probabilities/p-values).
  • Peptide Metadata: A DataFrame or data.frame containing peptide identifiers, and optionally start/end positions (pos_start, pos_end).
  • Sample Metadata: A DataFrame or data.frame containing sample names and group designations (e.g., "beads", "ctrl", "trt").

Key Parameters

  • counts (matrix): Raw read counts or pseudocounts for each peptide and sample.
  • logfc (matrix): Log2 estimated fold-changes compared to negative controls.
  • prob (matrix): Probabilities or p-values associated with enriched antibody response.
  • withDimnames (TRUE): In librarySize() and propReads(), controls whether output vectors/matrices retain row and column names.

Best Practices

  • Ensure that the sample metadata contains a column named group with a "beads" level to enable automatic identification of beads-only control samples via subsetBeads().
  • Use makeLibrary() to save peptide annotations as reusable templates, avoiding redundant re-importing of large peptide metadata files.
  • Coerce PhIPData objects to DGEList using as(phip_obj, "DGEList") when transitioning to edgeR for differential enrichment analysis.

Common Pitfalls

  • Missing peptide start/end positions: If pos_start and pos_end are missing from the peptide metadata, the constructor replaces them with 0 and prints a warning.
  • Missing required assays: Attempting to construct a PhIPData object without counts, logfc, or prob will result in empty matrices being initialized for the missing assays.
  • Case-sensitivity in aliases: Keys in the alias database (e.g., "hiv" vs "HIV") are case-sensitive; ensure consistent casing when calling getAlias().

Alternatives

  • SummarizedExperiment: For general-purpose coordinated representation of rectangular biological assay data.
  • RangedSummarizedExperiment: For genomic-coordinate-linked assay data.
  • edgeR (DGEList): For standard differential count analysis.

Citations

  • Chen A, Scharpf R, Ruczinski I (2026). PhIPData: A Container for PhIP-Seq Experiments. R package version 1.12.0.

References

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

The package contains functions for exploratory oligonucleotide array analysis. The dependence on tkWidgets only concerns few convenience functions. 'affy' is fully functional without it.

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb793Updated Jun 21, 2026

This tool uses the label-tree function from HyPhy to annotate a phylogenetic tree. It allows users to select a subset of leaves using either a regular expression or a list of sequence names, and then apply a specified label to these selecte

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb793Updated Jun 21, 2026

This package provides a client for the Bioconductor AnnotationHub web resource. The AnnotationHub web resource provides a central location where genomic files (e.g., VCF, bed, wig) and other resources from standard locations (e.g., UCSC, En

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb793Updated Jun 21, 2026

apeglm provides Bayesian shrinkage estimators for effect sizes for a variety of GLM models, using approximation of the posterior for individual coefficients.

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb793Updated Jun 21, 2026

ASURAT is a software for single-cell data analysis. Using ASURAT, one can simultaneously perform unsupervised clustering and biological interpretation in terms of cell type, disease, biological process, and signaling pathway activity. Inputting a single-cell RNA-seq data and knowledge-based databases, such as Cell Ontology, Gene Ontology, KEGG, etc., ASURAT transforms gene expression tables into original multivariate tables, termed sign-by-sample matrices (SSMs).

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb793Updated Jun 21, 2026

AUCell allows to identify cells with active gene sets (e.g. signatures, gene modules...) in single-cell RNA-seq data. AUCell uses the "Area Under the Curve" (AUC) to calculate whether a critical subset of the input gene set is enriched with

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb793Updated Jun 21, 2026

See all skills by bioMate-AI

Report a problem with this skill