Header menu logo ARCTokenization

CvParam

#r "nuget: ControlledVocabulary"

Installing Packages
  • ControlledVocabulary

Installing Packages
  • ControlledVocabulary.

Installing Packages
  • ControlledVocabulary..

Installing Packages
  • ControlledVocabulary...

Installing Packages
  • ControlledVocabulary....

Installed Packages
  • ControlledVocabulary, 1.0.1

CvParam is a value that is annotated with a controlled vocabulary term.

Suppose we have the name of a person ("Kevin Schneider").

We can annotate this value with a term to indicate that it is a name:

open ControlledVocabulary

let human =
    CvTerm.create(
        accession = "TO:00042069", // the term's unique accession number
        name = "Full Name", // the term name
        ref = "https://link/to/reference/vocabulary/named/TO" // the reference vocabulary
    )

let cvp = 
    CvParam(
        cvTerm = human,
        pv = ParamValue.Value "Kevin Schneider"
    )

cvp.ToString()
"CvParam: Full Name
	ID: TO:00042069
	RefUri: https://link/to/reference/vocabulary/named/TO
	Value: Value "Kevin Schneider"
	Attributes: []"
namespace ControlledVocabulary
val human: CvTerm
type CvTerm = { Accession: string Name: string RefUri: string } static member create: accession: string * name: string * ref: string -> CvTerm + 1 overload
<summary> Represents a term from a controlled vocabulary (Cv) in the form of: id|accession ; name|value ; refUri </summary>
static member CvTerm.create: name: string -> CvTerm
static member CvTerm.create: accession: string * name: string * ref: string -> CvTerm
Multiple items
val ref: value: 'T -> 'T ref

--------------------
type 'T ref = Ref<'T>
val cvp: CvParam
Multiple items
type CvParam = inherit CvAttributeCollection interface IParam new: cvAccession: string * cvName: string * cvRef: string * paramValue: ParamValue * attributes: IDictionary<string,IParam> -> CvParam + 6 overloads member Equals: term: CvTerm -> bool + 2 overloads override ToString: unit -> string member WithValue: v: ParamValue -> CvParam static member equals: cvp1: CvParam -> cvp2: CvParam -> bool static member equalsName: cvp1: CvParam -> cvp2: CvParam -> bool static member equalsTerm: term: CvTerm -> cvp: CvParam -> bool static member fromCategory: category: CvTerm -> term: CvTerm -> CvParam ...
<summary> Represents a structured value, annotated with a controlled vocabulary term Attributes can be used to further describe the CvParam </summary>

--------------------
new: cvTerm: CvTerm * pv: ParamValue -> CvParam
new: cvTerm: CvTerm * v: System.IConvertible -> CvParam
new: term: CvTerm * pv: ParamValue * attributes: IParam seq -> CvParam
new: id: string * name: string * ref: string * pv: ParamValue -> CvParam
new: id: string * name: string * ref: string * v: System.IConvertible -> CvParam
new: cvAccession: string * cvName: string * cvRef: string * paramValue: ParamValue * attributes: System.Collections.Generic.IDictionary<string,IParam> -> CvParam
new: id: string * name: string * ref: string * pv: ParamValue * attributes: IParam seq -> CvParam
type ParamValue = | Value of v: IConvertible | CvValue of cv: CvTerm | WithCvUnitAccession of cvu: IConvertible * CvUnit static member getValue: param: ParamValue -> IConvertible static member getValueAsInt: param: ParamValue -> int static member getValueAsString: param: ParamValue -> string static member getValueAsTerm: param: ParamValue -> CvTerm static member tryAddAccession: accession: string -> param: ParamValue -> ParamValue option static member tryAddName: name: string -> param: ParamValue -> ParamValue option static member tryAddReference: ref: string -> param: ParamValue -> ParamValue option static member tryAddUnit: unit: CvUnit -> param: ParamValue -> ParamValue option static member tryGetUnit: param: ParamValue -> CvUnit option
<summary> Represent the different cases of a parameter, which is either a simple value, a CvTerm or a simple value with CvUnit </summary>
union case ParamValue.Value: v: System.IConvertible -> ParamValue
override CvParam.ToString: unit -> string

Type something to start searching.