Workflow Name¶
Quick Facts¶
Please see the descriptions provided in our documentation contribution guide here
| Workflow Type | Applicable Kingdom | Last Known Changes | Command-line Compatibility | Workflow Level |
|---|---|---|---|---|
| Link to Workflow Type | Link to Applicable Kingdom | PHB <vX.X.X> | <command-line compatibility> | <workflow level on terra (set or sample)> |
Workflow_Name_On_Terra¶
Please provide a description of the workflow.
Workflow Name Diagram
If a workflow diagram is available, add it here. If not, remove this caption. See the page for TheiaCoV for an example.
Inputs¶
Input should be ordered as they appear on Terra. Any additional information regarding the inputs, such as suggestions or guidelines should be found before the table. See the page for Snippy_Streamline for an example.
| Terra Task Name | Variable | Type | Description | Default Value | Terra Status |
|---|---|---|---|---|---|
| task_name | variable_name | Type | Description | Default Value (leave blank if no default) | Required/Optional |
Workflow Tasks¶
Feel free to separate this section into subsections, like "Read QC" and "Alignment" if there are multiple tasks per subsection for easier navigation and readability. See the page for TheiaMeta for an example.
tool_name: Description of tool
Please provide a description of the task and the tool used
Tool Name Technical Details
| Links | |
|---|---|
| Task | [link to task on GitHub] |
| Software Source Code | [link to tool's source code] |
| Software Documentation | [link to tool's documentation] |
| Original Publication(s) | [link to tool's publication] |
Outputs¶
Outputs should be in alphabetical order by variable. Any additional information regarding the outputs, such as interpretation suggestions or more details, should be found after the table. See the page for Kraken2 for an example.
| Variable | Type | Description |
|---|---|---|
| variable_name | Type | Description |
References¶
Include this section if applicable.
reference1
reference2