nacho-accessors: Get the content of a nacho object

nacho-accessorsR Documentation

Get the content of a nacho object

Description

These accessors are the only public way into a nacho object.

Usage

nacho_counts(x, normalised = FALSE, log2 = FALSE)

nacho_samples(x)

nacho_probes(x)

nacho_qc(x)

Arguments

x

A nacho object from load_rcc() or normalise().

normalised

If TRUE, return the normalised counts instead of the raw counts.

log2

If TRUE, return log2(count + 1).

Value

  • nacho_counts(): a matrix with one row per probe and one column per sample.

  • nacho_samples(): a data frame with one row per sample; the first column holds the sample ids, and the PCA scores come last (PC01, PC02, ...). Detection_rate (the share of endogenous genes detected) and Housekeeping_detected (the number of housekeeping genes detected) are NA for a sample without a detection limit, and Housekeeping_detected is also NA for a miRNA panel that skips housekeeping normalisation. miRNA panels add Ligation_order, Ligation_R2 and Ligation_NEG (the ligation controls), and Haemolysis, the log2 ratio of ⁠miR-451a⁠ to ⁠miR-23a-3p⁠, when those probes are present.

  • nacho_probes(): a data frame with one row per probe: CodeClass, Name, Accession, detection_rate (the share of samples with a detection limit in which the probe is above it), is_housekeeping and is_excluded.

  • nacho_qc(): a data frame with one row per sample: the id, lane, CartridgeID, each quality-control metric with its status ("pass", "fail" or NA when it cannot be assessed), the other factors, lane_status for PlexSet files, n_flags (the sample's own failing metrics, not those inherited from its lane), the overall status and a readable reason (which also names the lane metrics a sample inherits).

Examples

data(GSE74821)
nacho_counts(GSE74821)[1:5, 1:3]
head(nacho_samples(GSE74821)[, 1:5])
head(nacho_probes(GSE74821))
head(nacho_qc(GSE74821))

NACHO documentation built on Nov. 2, 2026, 5:09 p.m.