ARC knowledge

Developer Toolstack

This guide focuses on the developer tools of ISA ARC, a reference domain implementation of ARC RDM. The system overview explains the shared architecture: annotation principles guide the abstract-model cores, while ARC RO-Crate profiles specify their expression in the Publication Space.

#ARCtrl - Developer Toolkit

ARCtrl

ARCtrl provides programmatic access to ISA ARC Workspace structures and metadata, including transformations into ARC RO-Crate. It is available for .NET, JavaScript and Python.

Supported formats, APIs and profile versions depend on the release. Use the ARCtrl documentation alongside the relevant workspace specifications and RO-Crate profiles.

Depending on your programming language, ARCtrl can be found via different package managers:

NuGetnpmPyPI
NugetNPMPyPI

#Handling representations

ISA ARC records investigation, study and assay metadata in ISA-XLSX and workflow/run metadata in WR-XLSX, alongside computational descriptions in CWL. Datamap spreadsheets describe files and their fragments; their current workbook conventions are documented within ISA-XLSX.

ARCtrl reads and writes these workspace structures and supports exchange operations such as ISA-JSON and ARC RO-Crate serialization. Check the release documentation for the implemented mappings.

The ARC Abstract Model defines shared entities and relationships independently of metadata serialization. Compilation maps information recorded in an ISA ARC Workspace to the selected ARC RO-Crate Core and Extension Profiles. Its coverage depends on the implemented mapping and the available context; support for an existing format should not be taken as support for every profile or extension.

For reproducible exports, record the source state, transformation, and profile versions.

#ARC manipulation

ARCtrl models investigations, studies, assays, workflows, runs and their associated metadata. Its APIs create, read, update and remove these structures and manipulate annotation tables. Experimental annotation-table rows describe processes; workflow/run metadata distinguishes reusable computational descriptions from their executions. Datamap entries describe data-file contents and identifiable fragments.

#Framework access

Applications can combine ARCtrl with community annotation templates and validation packages. These serve different purposes: templates guide metadata entry, while selected packages test requirements for a community or target. See the validation overview and the documentation of each service for its integration API.

#Transpilation

The packages share F# source code, compiled for .NET and transpiled to JavaScript and Python with Fable. A contract layer separates ARC operations from filesystem access so applications can provide the access methods appropriate to their runtime. Consult the package documentation for runtime requirements and supported APIs.

ARCtrl layers

#Usage

Tools built with ARCtrl include:

The published Workflow Run integration demonstrates how experimental processes and computational workflow/run descriptions can share a provenance graph while retaining their specialized representations. Exporting such metadata and submitting it to a publication service are separate operations; see exchange and publication.