Logo ProcessCore

Assay Module

Assay only contains "FileName" in isa.assay.xlsx. To unify naming in our model, on read-in we transform fileName to identifier and reverse for writing.

Functions and values

Function or value Description

Assay.datamapFileNameFromIdentifier identifier

Full Usage: Assay.datamapFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct assay identifier

Returns: string

On writing a xlsx file we unify our output to a relative path to ARC root. So: `assays/assayIdentifier/isa.datamap.xlsx`.

identifier : string

Any correct assay identifier

Returns: string

Assay.fileNameFromIdentifier identifier

Full Usage: Assay.fileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct assay identifier

Returns: string

On writing a xlsx file we unify our output to a relative path to ARC root. So: `assays/assayIdentifier/isa.assay.xlsx`.

identifier : string

Any correct assay identifier

Returns: string

Assay.identifierFromFileName fileName

Full Usage: Assay.identifierFromFileName fileName

Parameters:
    fileName : string - FileName as written in isa.assay.xlsx metadata sheet

Returns: string

On read-in the FileName can be any combination of "assays" (assay folder name), assayIdentifier and "isa.assay.xlsx" (the actual file name). This functions extracts assayIdentifier from any of these combinations and returns it.

fileName : string

FileName as written in isa.assay.xlsx metadata sheet

Returns: string

Assay.tryDatamapFileNameFromIdentifier identifier

Full Usage: Assay.tryDatamapFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct assay identifier

Returns: string option

On writing a xlsx file we unify our output to a relative path to ARC root. So: `assays/assayIdentifier/isa.datamap.xlsx`.

identifier : string

Any correct assay identifier

Returns: string option

Assay.tryFileNameFromIdentifier identifier

Full Usage: Assay.tryFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct assay identifier

Returns: string option

On writing a xlsx file we unify our output to a relative path to ARC root. So: `assays/assayIdentifier/isa.assay.xlsx`.

identifier : string

Any correct assay identifier

Returns: string option

Assay.tryIdentifierFromFileName fileName

Full Usage: Assay.tryIdentifierFromFileName fileName

Parameters:
    fileName : string - FileName as written in isa.assay.xlsx metadata sheet

Returns: string option

On read-in the FileName can be any combination of "assays" (assay folder name), assayIdentifier and "isa.assay.xlsx" (the actual file name). This functions extracts assayIdentifier from any of these combinations and returns it.

fileName : string

FileName as written in isa.assay.xlsx metadata sheet

Returns: string option

Type something to start searching.