UNPKG

@nfdi4plants/swate-components

Version:

Customizable React components for ontology annotation, based on Swate and the ARC.

215 lines 13.1 kB
import { Person } from './Person.fs.js'; import { Comment$ } from './Comment.fs.js'; import { Option } from '@fable-org/fable-library-js/Option.js'; import { OntologyAnnotation } from './OntologyAnnotation.fs.js'; import { Value_$union } from './Value.fs.js'; import { CompositeCell_$union } from './Table/CompositeCell.fs.js'; import { Component } from './Process/Component.fs.js'; import { CompositeHeader_$union } from './Table/CompositeHeader.fs.js'; import { ProtocolParameter } from './Process/ProtocolParameter.fs.js'; import { ProcessParameterValue } from './Process/ProcessParameterValue.fs.js'; import { FactorValue } from './Process/FactorValue.fs.js'; import { Factor } from './Process/Factor.fs.js'; import { MaterialAttributeValue } from './Process/MaterialAttributeValue.fs.js'; import { MaterialAttribute } from './Process/MaterialAttribute.fs.js'; import { ProcessInput_$union } from './Process/ProcessInput.fs.js'; import { ProcessOutput_$union } from './Process/ProcessOutput.fs.js'; import { int32 } from '@fable-org/fable-library-js/Int32.js'; import { ArcTable } from './Table/ArcTable.fs.js'; import { FSharpList } from '@fable-org/fable-library-js/List.js'; import { Process } from './Process/Process.fs.js'; import { Protocol } from './Process/Protocol.fs.js'; import { ArcTables } from './Table/ArcTables.fs.js'; export declare const Person_orcidKey = "ORCID"; export declare const Person_AssayIdentifierPrefix = "performer (ARC:00000168)"; export declare const Person_createAssayIdentifierKey: ((arg0: string) => string); export declare function Person_setSourceAssayComment(person: Person, assayIdentifier: string): Person; /** * This functions helps encoding/decoding ISA-JSON. It returns a sequence of ArcAssay-Identifiers. */ export declare function Person_getSourceAssayIdentifiersFromComments(person: Person): Iterable<string>; export declare function Person_removeSourceAssayComments(person: Person): Comment$[]; export declare function Person_setOrcidFromComments(person: Person): Person; export declare function Person_setCommentFromORCID(person: Person): Person; /** * Convert a CompositeCell to a ISA Value and Unit tuple. */ export declare function JsonTypes_valueOfCell(value: CompositeCell_$union): [Option<Value_$union>, Option<OntologyAnnotation>]; /** * Convert a CompositeHeader and Cell tuple to a ISA Component */ export declare function JsonTypes_composeComponent(header: CompositeHeader_$union, value: CompositeCell_$union): Component; /** * Convert a CompositeHeader and Cell tuple to a ISA ProcessParameterValue */ export declare function JsonTypes_composeParameterValue(header: CompositeHeader_$union, value: CompositeCell_$union): ProcessParameterValue; /** * Convert a CompositeHeader and Cell tuple to a ISA FactorValue */ export declare function JsonTypes_composeFactorValue(header: CompositeHeader_$union, value: CompositeCell_$union): FactorValue; /** * Convert a CompositeHeader and Cell tuple to a ISA MaterialAttributeValue */ export declare function JsonTypes_composeCharacteristicValue(header: CompositeHeader_$union, value: CompositeCell_$union): MaterialAttributeValue; export declare function JsonTypes_composeFreetextMaterialName(headerFT: string, name: string): string; /** * Convert a CompositeHeader and Cell tuple to a ISA ProcessInput */ export declare function JsonTypes_composeProcessInput(header: CompositeHeader_$union, value: CompositeCell_$union): ProcessInput_$union; /** * Convert a CompositeHeader and Cell tuple to a ISA ProcessOutput */ export declare function JsonTypes_composeProcessOutput(header: CompositeHeader_$union, value: CompositeCell_$union): ProcessOutput_$union; /** * Convert an ISA Value and Unit tuple to a CompositeCell */ export declare function JsonTypes_cellOfValue(value: Option<Value_$union>, unit: Option<OntologyAnnotation>): CompositeCell_$union; /** * Convert an ISA Component to a CompositeHeader and Cell tuple */ export declare function JsonTypes_decomposeComponent(c: Component): [CompositeHeader_$union, CompositeCell_$union]; /** * Convert an ISA ProcessParameterValue to a CompositeHeader and Cell tuple */ export declare function JsonTypes_decomposeParameterValue(ppv: ProcessParameterValue): [CompositeHeader_$union, CompositeCell_$union]; /** * Convert an ISA FactorValue to a CompositeHeader and Cell tuple */ export declare function JsonTypes_decomposeFactorValue(fv: FactorValue): [CompositeHeader_$union, CompositeCell_$union]; /** * Convert an ISA MaterialAttributeValue to a CompositeHeader and Cell tuple */ export declare function JsonTypes_decomposeCharacteristicValue(cv: MaterialAttributeValue): [CompositeHeader_$union, CompositeCell_$union]; /** * Convert an ISA ProcessOutput to a CompositeHeader and Cell tuple */ export declare function JsonTypes_decomposeProcessInput(pi: ProcessInput_$union): [CompositeHeader_$union, CompositeCell_$union]; /** * Convert an ISA ProcessOutput to a CompositeHeader and Cell tuple */ export declare function JsonTypes_decomposeProcessOutput(po: ProcessOutput_$union): [CompositeHeader_$union, CompositeCell_$union]; /** * This function creates a string containing the name and the ontology short-string of the given ontology annotation term * * TechnologyPlatforms are plain strings in ISA-JSON. * * This function allows us, to parse them as an ontology term. */ export declare function JsonTypes_composeTechnologyPlatform(tp: OntologyAnnotation): string; /** * This function parses the given string containing the name and the ontology short-string of the given ontology annotation term * * TechnologyPlatforms are plain strings in ISA-JSON. * * This function allows us, to parse them as an ontology term. */ export declare function JsonTypes_decomposeTechnologyPlatform(name: string): OntologyAnnotation; /** * If the given headers depict a component, returns a function for parsing the values of the matrix to the values of this component */ export declare function ProcessParsing_tryComponentGetter(generalI: int32, valueI: int32, valueHeader: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => Component))>; /** * If the given headers depict a parameter, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryParameterGetter(generalI: int32, valueI: int32, valueHeader: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => ProcessParameterValue))>; /** * If the given headers depict a factor, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryFactorGetter(generalI: int32, valueI: int32, valueHeader: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => FactorValue))>; /** * If the given headers depict a protocolType, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryCharacteristicGetter(generalI: int32, valueI: int32, valueHeader: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => MaterialAttributeValue))>; /** * If the given headers depict a protocolType, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryGetProtocolTypeGetter(generalI: int32, header: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => OntologyAnnotation))>; /** * If the given headers depict a protocolREF, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryGetProtocolREFGetter(generalI: int32, header: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => string))>; /** * If the given headers depict a protocolDescription, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryGetProtocolDescriptionGetter(generalI: int32, header: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => string))>; /** * If the given headers depict a protocolURI, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryGetProtocolURIGetter(generalI: int32, header: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => string))>; /** * If the given headers depict a protocolVersion, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryGetProtocolVersionGetter(generalI: int32, header: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => string))>; /** * If the given headers depict an input, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryGetInputGetter(generalI: int32, header: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => ProcessInput_$union))>; /** * If the given headers depict an output, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryGetOutputGetter(generalI: int32, header: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => ProcessOutput_$union))>; /** * If the given headers depict a comment, returns a function for parsing the values of the matrix to the values of this type */ export declare function ProcessParsing_tryGetCommentGetter(generalI: int32, header: CompositeHeader_$union): Option<((arg0: ArcTable) => ((arg0: int32) => Comment$))>; /** * Given the header sequence of an ArcTable, returns a function for parsing each row of the table to a process */ export declare function ProcessParsing_getProcessGetter(processNameRoot: string, headers: Iterable<CompositeHeader_$union>): ((arg0: ArcTable) => ((arg0: int32) => Process)); /** * Groups processes by their name, or by the name of the protocol they execute * * Process names are taken from the Worksheet name and numbered: SheetName_1, SheetName_2, etc. * * This function decomposes this name into a root name and a number, and groups processes by root name. */ export declare function ProcessParsing_groupProcesses(ps: FSharpList<Process>): FSharpList<[string, FSharpList<Process>]>; /** * Merges processes with the same name, protocol and param values */ export declare function ProcessParsing_mergeIdenticalProcesses(processes: FSharpList<Process>): FSharpList<Process>; export declare function ProcessParsing_processToRows(p: Process): FSharpList<FSharpList<[CompositeHeader_$union, CompositeCell_$union]>>; export declare function ARCtrl_CompositeHeader__CompositeHeader_TryParameter(this$: CompositeHeader_$union): Option<ProtocolParameter>; export declare function ARCtrl_CompositeHeader__CompositeHeader_TryFactor(this$: CompositeHeader_$union): Option<Factor>; export declare function ARCtrl_CompositeHeader__CompositeHeader_TryCharacteristic(this$: CompositeHeader_$union): Option<MaterialAttribute>; export declare function ARCtrl_CompositeHeader__CompositeHeader_TryComponent(this$: CompositeHeader_$union): Option<Component>; /** * This function is used to improve interoperability with ISA-JSON types. It is not recommended for default ARCtrl usage. */ export declare function ARCtrl_CompositeCell__CompositeCell_fromValue_Static_Z6986DF18(value: Value_$union, unit?: OntologyAnnotation): CompositeCell_$union; export declare function CompositeRow_toProtocol(tableName: string, row: Iterable<[CompositeHeader_$union, CompositeCell_$union]>): Protocol; /** * Create a new table from an ISA protocol. * * The table will have at most one row, with the protocol information and the component values */ export declare function ARCtrl_ArcTable__ArcTable_fromProtocol_Static_3BF20962(p: Protocol): ArcTable; /** * Returns the list of protocols executed in this ArcTable */ export declare function ARCtrl_ArcTable__ArcTable_GetProtocols(this$: ArcTable): FSharpList<Protocol>; /** * Returns the list of processes specidified in this ArcTable */ export declare function ARCtrl_ArcTable__ArcTable_GetProcesses(this$: ArcTable): FSharpList<Process>; /** * Create a new table from a list of processes * * The name will be used as the sheet name * * The processes SHOULD have the same headers, or even execute the same protocol */ export declare function ARCtrl_ArcTable__ArcTable_fromProcesses_Static(name: string, ps: FSharpList<Process>): ArcTable; /** * Return a list of all the processes in all the tables. */ export declare function ARCtrl_ArcTables__ArcTables_GetProcesses(this$: ArcTables): FSharpList<Process>; /** * Create a collection of tables from a list of processes. * * For this, the processes are grouped by nameroot ("nameroot_1", "nameroot_2" ...) or exectued protocol if no name exists * * Then each group is converted to a table with this nameroot as sheetname */ export declare function ARCtrl_ArcTables__ArcTables_fromProcesses_Static_62A3309D(ps: FSharpList<Process>): ArcTables; //# sourceMappingURL=Conversion.fs.d.ts.map