Skip to contents

Summarise a project

Usage

sg_roi_summary(project, call = rlang::caller_env())

Arguments

project

An sg_roi_project.

call

The calling environment, for error reporting.

Value

An sg_roi_summary object: a list with n_layers, n_rois, per-label ROI counts, and total area per label.

Examples

lyr <- sg_roi_layer_add(sg_roi_layer("tissue"),
                        sg_roi_rect(2, 2, 8, 8, label = "tissue"))
proj <- sg_roi_project(sg_roi_frame(c(20, 20)), lyr)
sg_roi_summary(proj)
#> <sg_roi_summary> NA
#> layers: 1  |  ROIs: 1
#>   "tissue": 1 ROI, area 36 px