Logo ProcessCore

Run Module

Functions and values

Function or value Description

Run.cwlFileNameFromIdentifier identifier

Full Usage: Run.cwlFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct run identifier

Returns: string

On writing a cwl file we unify our output to a relative path to ARC root. So: `runs/runIdentifier/run.cwl`.

identifier : string

Any correct run identifier

Returns: string

Run.datamapFileNameFromIdentifier identifier

Full Usage: Run.datamapFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct run identifier

Returns: string

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

identifier : string

Any correct run identifier

Returns: string

Run.fileNameFromIdentifier identifier

Full Usage: Run.fileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct run identifier

Returns: string

On writing a xlsx file we unify our output to a relative path to ARC root. So: `runs/runIdentifier/isa.run.xlsx`.

identifier : string

Any correct run identifier

Returns: string

Run.identifierFromFileName fileName

Full Usage: Run.identifierFromFileName fileName

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

Returns: string

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

fileName : string

FileName as written in isa.run.xlsx metadata sheet

Returns: string

Run.tryCwlFileNameFromIdentifier identifier

Full Usage: Run.tryCwlFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct run identifier

Returns: string option

On writing a cwl file we unify our output to a relative path to ARC root. So: `runs/runIdentifier/run.cwl`.

identifier : string

Any correct run identifier

Returns: string option

Run.tryDatamapFileNameFromIdentifier identifier

Full Usage: Run.tryDatamapFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct run identifier

Returns: string option

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

identifier : string

Any correct run identifier

Returns: string option

Run.tryFileNameFromIdentifier identifier

Full Usage: Run.tryFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct run identifier

Returns: string option

On writing a xlsx file we unify our output to a relative path to ARC root. So: `runs/runIdentifier/isa.run.xlsx`.

identifier : string

Any correct run identifier

Returns: string option

Run.tryIdentifierFromFileName fileName

Full Usage: Run.tryIdentifierFromFileName fileName

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

Returns: string option

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

fileName : string

FileName as written in isa.run.xlsx metadata sheet

Returns: string option

Run.tryYmlFileNameFromIdentifier identifier

Full Usage: Run.tryYmlFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct run identifier

Returns: string option

On writing a yml file we unify our output to a relative path to ARC root. So: `runs/runIdentifier/run.yml`.

identifier : string

Any correct run identifier

Returns: string option

Run.ymlFileNameFromIdentifier identifier

Full Usage: Run.ymlFileNameFromIdentifier identifier

Parameters:
    identifier : string - Any correct run identifier

Returns: string

On writing a yml file we unify our output to a relative path to ARC root. So: `runs/runIdentifier/run.yml`.

identifier : string

Any correct run identifier

Returns: string

Type something to start searching.