Run Module
Functions and values
| Function or value |
Description
|
Full Usage:
Run.cwlFileNameFromIdentifier identifier
Parameters:
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`.
|
Full Usage:
Run.datamapFileNameFromIdentifier identifier
Parameters:
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`.
|
Full Usage:
Run.fileNameFromIdentifier identifier
Parameters:
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`.
|
Full Usage:
Run.identifierFromFileName fileName
Parameters:
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.
|
Full Usage:
Run.tryCwlFileNameFromIdentifier identifier
Parameters:
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`.
|
Full Usage:
Run.tryDatamapFileNameFromIdentifier identifier
Parameters:
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`.
|
Full Usage:
Run.tryFileNameFromIdentifier identifier
Parameters:
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`.
|
Full Usage:
Run.tryIdentifierFromFileName fileName
Parameters:
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.
|
Full Usage:
Run.tryYmlFileNameFromIdentifier identifier
Parameters:
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`.
|
Full Usage:
Run.ymlFileNameFromIdentifier identifier
Parameters:
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`.
|
ProcessCore