Skip to contents

Describes what this installation of segmantR can exchange: schema and API versions, interoperability profiles with their status ("supported", "planned" or "unavailable"), file formats, protocols, optional backends and limits. Optional Python backends are only probed when check_backends = TRUE; QuPath is detected from installation files without starting it.

Usage

sg_interchange_capabilities(check_backends = FALSE)

Arguments

check_backends

Logical; probe optional Python backends through reticulate. Python is initialised only when one has been selected (see the section "Selecting Python" in sg_setup_python()); otherwise they are reported as unavailable.

Value

An sg_capabilities list conforming to capabilities.schema.json, with a digest over its content.

Details

Profiles: I0 neutral files (manifest, integer TIFF masks, GeoJSON, measurements, integrity inventory); I1 versioned protocols and run envelopes; models model bundles with runtime and checksums; qupath_programs Groovy templates and run.json; stardist_qupath the StarDist extension adapter; control the local control service (segmantR-control-v1); partner_qupflowR and partner_hyperannotatR the partner contracts, which stay planned until a real consumer and QuPath evidence exist.

Examples

caps <- sg_interchange_capabilities()
caps$profiles$I0$status
#> [1] "supported"
caps$schema
#> [1] "segmantR-interchange-v1"