ARC Type
Constructors
| Constructor |
Description
|
Full Usage:
ARC(identifier, ?title, ?description, ?additionalType, ?license, ?datePublished, ?dateCreated, ?dateModified, ?processes, ?hasPart, ?dataFiles, ?agents, ?citations, ?dataContexts, ?additionalProperty, ?samples, ?recipes)
Parameters:
string
?title : string
?description : string
?additionalType : string
?license : string
?datePublished : string
?dateCreated : string
?dateModified : string
?processes : Process seq
?hasPart : Dataset seq
?dataFiles : Data seq
?agents : Agent seq
?citations : ScholarlyArticle seq
?dataContexts : DataContext seq
?additionalProperty : Annotation seq
?samples : Sample seq
?recipes : Recipe seq
Returns: ARC
|
|
Instance members
| Instance member |
Description
|
|
|
|
|
Full Usage:
this.ArcPath
Returns: string option
|
|
Full Usage:
this.IsSpreadsheetScaffold
Returns: bool
|
|
|
|
|
|
|
|
|
|
Full Usage:
this.Update
Parameters:
string
|
Updates the ARC at the specified path, re-resolving an authoritative destination project when present. If no path is provided, it will use the ArcPath property. If neither is set, it will throw an exception.
|
|
Updates the ARC at the specified path. A destination project file is authoritative and is re-resolved on every update. If no path is provided, it will use the ArcPath property. If neither is set, it will throw an exception.
|
Full Usage:
this.Write
Parameters:
string
|
Writes the ARC using .arc/project.yml when present; otherwise writes arc.yml.
|
|
Writes the ARC using .arc/project.yml when present; otherwise writes arc.yml.
|
Full Usage:
this.WriteProject
Parameters:
CodecRegistry
workspaceRoot : string
Returns: Result<unit, ProjectError>
|
Writes the ARC through the exact .arc/project.yml using the supplied codec registry.
|
Full Usage:
this.WriteProjectAsync
Parameters:
CodecRegistry
workspaceRoot : string
Returns: CrossAsync<Result<unit, ProjectError>>
|
Writes the ARC through the exact .arc/project.yml using the supplied codec registry.
|
Full Usage:
this.WriteXLSX
Parameters:
string
|
Writes the ARC to the specified path as a spreadsheet scaffold and makes XLSX the active representation.
|
|
Writes the ARC to the specified path as a spreadsheet scaffold and makes XLSX the active representation.
|
Full Usage:
this.WriteYML
Parameters:
string
|
Writes the ARC to the specified path as arc.yml and makes YAML the active representation.
|
|
Writes the ARC to the specified path as arc.yml and makes YAML the active representation.
|
Full Usage:
this.toYamlString ?whiteSpace
Parameters:
int
Returns: string
|
|
Static members
| Static member |
Description
|
|
|
|
Loads an ARC using an authoritative .arc/project.yml when present, otherwise using existing YAML/XLSX discovery. If neither is found, it throws an exception.
|
|
Loads an ARC from an exact .arc/project.yml when present. Otherwise it uses the existing arc.yml/XLSX discovery.
|
Full Usage:
ARC.loadProject (registry, workspaceRoot)
Parameters:
CodecRegistry
workspaceRoot : string
Returns: Result<ARC, ProjectError>
|
Loads an ARC through the exact .arc/project.yml using the supplied codec registry.
|
Full Usage:
ARC.loadProjectAsync (registry, workspaceRoot)
Parameters:
CodecRegistry
workspaceRoot : string
Returns: CrossAsync<Result<ARC, ProjectError>>
|
Loads an ARC through the exact .arc/project.yml using the supplied codec registry.
|
|
|
|
Loads an ARC from the spreadsheet scaffold in the specified path.
|
|
|
|
Inherited members
Inherited from
Dataset
Instance members
| Instance member |
Description
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
All distinct Annotations from all sources across all processes in this dataset. Sources: process parameters, input/output node properties, recipe components. Optional recipeName restricts to processes whose recipe name matches.
|
|
|
|
|
|
|
|
All distinct Data nodes reachable from processes in this dataset
|
|
|
|
|
|
All distinct IONodes (samples and data) from all processes in this dataset.
|
|
|
|
All processes in this dataset and all nested datasets (depth-first)
|
|
All distinct Sample nodes reachable from processes in this dataset
|
Full Usage:
this.AnnotationsForNode
Parameters:
IONode
?recipeName : string
Returns: ResizeArray<Annotation>
|
All Annotations from all sources connected to `node` (upstream + downstream) within this dataset. Optional recipeName restricts to processes whose recipe name matches.
|
|
Returns the canonical IONode for `node` from the root registry. Registers and returns `node` itself if its key is not yet present. When the key is already registered, compatible metadata is merged into the canonical instance and conflicting metadata raises an exception.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
this.DataWithDataContextByExplication
Parameters:
DefinedTerm
Returns: ResizeArray<Data * DataContext>
|
|
Full Usage:
this.DownstreamAnnotationsForNode
Parameters:
IONode
?recipeName : string
Returns: ResizeArray<Annotation>
|
Annotations from all sources in processes downstream of `node` within this dataset.
|
|
Final nodes that are Data.
|
|
All IONodes in this dataset with no successor process (terminal sinks).
|
|
Final nodes that are Samples.
|
Full Usage:
this.FindProcessesByAnnotation
Parameters:
string
paramValue : string
Returns: ResizeArray<Process>
|
All processes that have a Annotation (from any source) with the given name and value.
|
Full Usage:
this.FindProcessesByPropertyName
Parameters:
string
Returns: ResizeArray<Process>
|
All processes that have a Annotation (from any source) with the given name (any value).
|
Full Usage:
this.FindProcessesByRecipeType
Parameters:
string
Returns: ResizeArray<Process>
|
All processes whose executed recipe's intendedUse name matches.
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
this.RecipeParametersForNode
Parameters:
IONode
Returns: ResizeArray<FormalParameter>
|
|
|
Register a fragment selector provider in the root dataset of this hierarchy.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Root nodes that are Data.
|
|
All IONodes in this dataset with no predecessor process (terminal sources).
|
|
Root nodes that are Samples.
|
|
|
Full Usage:
this.SamplesResultingFromConditionBy
Parameters:
string
paramPredicate : Annotation -> bool
Returns: ResizeArray<Sample>
|
Find qualifying processes by recipe type, then filter their ParameterValues with a caller-supplied predicate. Returns all terminal-output Samples of the downstream subgraphs of qualifying processes.
|
|
|
|
|
Full Usage:
this.TryGetFragmentSelectorProvider
Parameters:
string
Returns: IFragmentSelectorProvider option
|
Returns a fragment selector provider from the root dataset, if registered.
|
|
|
|
|
|
|
Full Usage:
this.UnregisterFragmentSelectorProvider
Parameters:
string
|
Remove a fragment selector provider from the root dataset.
|
Full Usage:
this.UpstreamAnnotationsForNode
Parameters:
IONode
?recipeName : string
Returns: ResizeArray<Annotation>
|
Annotations from all sources in processes upstream of `node` within this dataset.
|
Full Usage:
this.DateModified
Returns: string option
|
|
|
|
Full Usage:
this.AdditionalType
Returns: string option
|
Decoration discriminator (e.g. "Investigation", "Study", "Assay")
|
|
|
Full Usage:
this.DateCreated
Returns: string option
|
|
Full Usage:
this.Identifier
Returns: string
|
|
|
|
|
|
|
|
Full Usage:
this.License
Returns: string option
|
|
|
Back-edge: parent dataset
|
|
|
|
|
Full Usage:
this.Title
Returns: string option
|
|
Full Usage:
this.DatePublished
Returns: string option
|
|
Full Usage:
this.Description
Returns: string option
|
|
ProcessCore