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)