ARC

The core entity of ARCtrl is of course the ARC object. It’s an in-memory representation of an ARC Scaffold.

This class contains three properties:

• ISA of type ARCInvestigation
• CWL
• FileSystem of type FileSystem

The constructor takes these three values as inputs, but you can also initialize an empty ARC in memory.

FSharp

open ARCtrl

let arc = ARC()

JavaScript

import {ARC} from "@nfdi4plants/arctrl";

let arc = new ARC()

Python

from arctrl import ARC

arc = ARC()

Read and write

Section titled Read and write

ARCtrl offers a variety of IO functionality to read and write ARCs.

Load

Section titled Load

The load function reads the ARC Scaffold representation for a given path.

FSharp

open ARCtrl

let myArcPath = @"arcs/myARC/"

let arc = ARC.load(myArcPath)

JavaScript

import {ARC} from "@nfdi4plants/arctrl";

let myArcPath = "arcs/myARC/"

ARC.loadAsync(myArcPath)

Python

from arctrl.arc import ARC

myArcPath = "arcs/myARC/"

arc = ARC.load(myArcPath)

Write

Section titled Write

The write function writes the whole ARC as its Scaffold representation to a given path. It will overwrite all metadata files like isa.assay.xlsx and such.

FSharp

open ARCtrl

let myArcPath = @"arcs/myARC/"

arc.Write(myArcPath)

JavaScript

import {ARC} from "@nfdi4plants/arctrl";

let myArcPath = "arcs/myARC/"

arc.WriteAsync(myArcPath)

Python

from arctrl.arc import ARC

myArcPath = "arcs/myARC/"

arc.Write(myArcPath)

Update

Section titled Update

The update function updates the ARC as its Scaffold representation to a given path. It will only write those entities which have changed in the datamodel since the last load, write or update operation.

FSharp

open ARCtrl

let myArcPath = @"arcs/myARC/"

arc.Update(myArcPath)

JavaScript

import {ARC} from "@nfdi4plants/arctrl";

let myArcPath = "arcs/myARC/"

arc.UpdateAsync(myArcPath)

Python

from arctrl.arc import ARC

myArcPath = "arcs/myARC/"

arc.Update(myArcPath)

RO-Crate

Section titled RO-Crate

ARCs can seemlessly be read from and parsed to their RO-Crate JSON-LD string representation:

FSharp

let jsonString = arc.ToROCrateJsonString(spaces = 2)

let arc2 = ARC.fromROCrateJsonString(jsonString)

JavaScript

let jsonString = arc.ToROCrateJsonString(2)

let arc2 = ARC.fromROCrateJsonString(jsonString)

Python

jsonString = arc.ToROCrateJsonString(spaces = 2)

arc2 = ARC.from_rocrate_json_string(jsonString)