Repository navigation
Tokens & Variables
Vince LaGrassa edited this page Mar 20, 2025
·
18 revisions
Tokens are changing values that may be used in strings. They are typically used in filenames / filepaths, to distinguish e.g. between data files for different species or different releases.
For example, some filepaths may be given in the format:
... /{ SPECIES }/{ RELEASE }/sample_file_name-{ SPECIES }-{ RELEASE }.txt
If we wanted to use the version of this file associated with C. elegans from the (made-up) CaeNDR release on Jan 1, 2000, we would look for the file:
... /c_elegans/20000101/sample_file_name-c_elegans-20000101.txt
| Token | Description | Values |
|---|---|---|
SPECIES |
The relevant Caenorhabditis species for a given dataset or operation. The (unofficial) format is genus initial + underscore + species name -- in our case, this means all valid values begin with c_. |
c_elegans, c_briggsae, c_tropicalis
|
RELEASE |
The CaeNDR release that a data file was released in. New values added when new dataset releases are created. | "YYYYMMDD" format |
PRJ |
WormBase project number associated with a dataset or release. Pulled from WormBase. May not be relevant going forward, with new CaeNDR release format. |
PRJNA13758, etc. |
WB |
WormBase version associated with a dataset or release. Pulled from WormBase. May not be relevant going forward, with new CaeNDR release format. |
WS276, etc. |
SVA |
The CaeNDR release to use for the Strain Variant Annotation table & tool. This has the same format (and possible values?) as the RELEASE token, but is kept separate because this tool may lag behind the most recent CaeNDR release - i.e. the SVA release and the "main" release may be different. |
"YYYYMMDD" format, same as RELEASE
|
STRAIN |
An identifier for a specific strain. Mostly relevant for the Genome Browser tool's IGV Browser element, which needs to pull files for specific strains. |
BRC20067, etc. |
GENOME |
The FASTA genome identifier attached to a given release. I believe this is now a more generic version of the WB token, since CaeNDR generalized from using specifically WormBase data to also using lab-produced genomes. Typically 1-to-1 with RELEASE values, but (a) it is possible for multiple CaeNDR releases to use the same genome, and (b) the genome value may be lab-internal or lab-specific, i.e. have some meaning within the lab that isn't captured by the CaeNDR release value alone. |
Could be anything - WS276 (from WormBase), Feb2020 (from Andersen Lab), etc. |
USER_ID |
... | ... |
Getting set up? Start here!
Looking for tutorials on the software & services we use?
Trying to figure out what goes where?
Want to make changes?
Having trouble?
- Troubleshooting