gatekeepR

gatekeepR turns per-cell marker measurements from multiplexed tissue images into cell types that a person has reviewed.

• Suggest cut-offs: estimates a threshold for each marker on each slide, and says openly when a marker cannot be called.
• Classify: applies one declared phenotype hierarchy.
• Review: lets a reviewer adjust cut-offs, decide on epithelial structures and exclude artefacts in a Shiny app.
• Lock: freezes the result into a single immutable review snapshot, which every exported file and every later analysis refers to.

Status: 1.0.0 release candidate. The configuration, preparation, correction, threshold, classification, review, export and plotting paths are implemented. The package is being checked for its first CRAN submission.

Why

Semi-automated gating is where multiplex imaging studies are most fragile:

• Automatic cut-offs look confident even when a marker has no signal. Gating code tends to produce a threshold for every marker, including a channel that was never stained.
• Batch scripts and review apps drift apart. Each carries its own copy of the phenotype rules.
• Review decisions get lost. An import can overwrite them, and exported files cannot be traced back to the one review they came from.

gatekeepR is built so that each of these failures becomes an error or a visible status instead:

• one classifier shared by batch and app;
• explicit callability;
• append-only review ledgers;
• content-addressed, verifiable export packages.

Scope

In scope

• Panel definition: a marker panel with roles (identity, state, context, conditional), signal compartments, and localisation rules for markers such as nuclear FOXP3 or Ki67.
• Callability: checks run before any threshold is estimated (absent, constant or unsupported channels).
• Threshold methods:
  • manual
  • density valley
  • density tail
  • two-component mixture
  • population density crossing on an embedding
  • parent-specific estimation for state markers
• Phenotype hierarchy: declarative, ordered and versioned, with explicit classes for ambiguous objects and for cells awaiting review.
• State calls: every marker × parent combination is estimated and exported, not just the one currently displayed.
• Review support: spatial grouping of candidate epithelial structures for tumour vs. benign decisions.
• Review app: cut-offs, structures, exclusions and deletions, state markers. Downloads come only from a locked snapshot.
• Export verification: replays and reconciles labels, decisions and deletion histories.

Out of scope

• Reading tool exports (→ cellspecR).
• Segmentation (→ QuPath / qupflowR, segmantR).
• Spatial statistics, neighbourhoods and cohort analysis (→ phenoscapR).
• Shipping study-specific panels or cut-offs: those live with each study.

Where it sits in CTTIR

cellspecR (validated cell table + signal policy)
      │
      ▼
gatekeepR: callability → thresholds → hierarchy → state calls
      │           ▲
      │           └── review app (cut-offs, structures, exclusions)
      ▼
locked snapshot (review_id, hashes, ledgers, calls)
      │
      ▼
phenoscapR / cohort statistics / reports

Interface

Area	Functions
Panel and rules	gk_panel(), gk_hierarchy(), gk_read_config(), gk_write_config()
Signals	gk_prepare(), gk_callability(), gk_correct()
Thresholds	gk_thresholds(), gk_threshold_methods(), gk_embed()
Classification	gk_classify(), gk_state_calls(), gk_structures()
Review	gk_review(), gk_set_cut(), gk_decide_structure(), gk_dispose(), gk_set_state(), gk_revert_last(), gk_import_cuts(), gk_replace_review(), gk_save_review(), gk_load_review()
Snapshot	gk_lock(), gk_export(), gk_verify_export(), gk_read_export(), gk_replay()
Plots	gk_plot_overview(), gk_plot_density(), gk_plot_map(), gk_plot_embedding(), gk_plot_dotplot(), gk_plot_thresholds(), gk_plot_states()
Example data	gk_example_config(), gk_example_path(), gk_simulate()
App	gk_app(), a review application that also runs from shinylaunchR

config <- gk_example_config()
x      <- gk_read_cellspec(gk_example_path("example-slide"))
prep   <- gk_prepare(x, config, quiet = TRUE)
fixed  <- gk_correct(prep, method = "robust_z")
emb    <- gk_embed(prep, correction = fixed, seed = 42)
thr    <- gk_thresholds(prep, config, embedding = emb, correction = fixed)
cls    <- gk_classify(prep, thr, config, correction = fixed)
states <- gk_state_calls(prep, thr, cls, config)
shapes <- gk_structures(cls, prep)

rev    <- gk_review(cls, states, shapes, thr, prep)
snap   <- gk_lock(rev, reviewer = "reviewer-01", status = "REVIEWED")
gk_export(snap, "reviews/example-01")
gk_verify_export("reviews/example-01")

Installation

# install.packages("pak")
pak::pak("CTTIR/gatekeepR")

The development version can be installed from GitHub. Optional features use packages listed in Suggests, including uwot, dbscan, ggplot2, shiny and patchwork.

Contributing

Follows the CTTIR contributing guide.

License

MIT