Skip to content

Commit b3662a8

Browse files
supernordsupernord
authored
Merge pull request #8 from AustralianBioCommons/v1.5
Update workflows.md structure
2 parents a1fe222 + 4e6c590 commit b3662a8

File tree

1 file changed

+34
-96
lines changed

1 file changed

+34
-96
lines changed

‎documentation_templates/workflows.md‎

Lines changed: 34 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,13 @@
55
- [Diagram](#diagram)
66
- [User guide](#user-guide)
77
- [Quick start guide](#quick-start-guide)
8+
- [Required (minimum)
9+
inputs/parameters](#required-minimum-inputsparameters)
810
- [Infrastructure usage and
911
recommendations](#infrastructure-usage-and-recommendations)
1012
- [Compute resource usage across tested
1113
infrastructures](#compute-resource-usage-across-tested-infrastructures)
12-
- [Benchmarking](#benchmarking)
13-
- [Workflow summaries](#workflow-summaries)
14-
- [Metadata](#metadata)
15-
- [Component tools](#component-tools)
16-
- [Required (minimum)
17-
inputs/parameters](#required-minimum-inputsparameters)
14+
- [Benchmarking](#benchmarking)
1815
- [Additional notes](#additional-notes)
1916
- [Help/FAQ/Troubleshooting](#helpfaqtroubleshooting)
2017
- [3rd party Tutorials](#3rd-party-tutorials)
@@ -23,131 +20,72 @@
2320

2421
---
2522

26-
# Description
27-
28-
```
29-
Introduction of workflow and its component tools.
23+
## Description
3024

31-
Table with embedded registry links.
32-
```
25+
> Introduction of workflow and its component tools.
26+
> Table with embedded registry links.
3327
34-
---
3528

36-
# Diagram
29+
## Diagram
3730

38-
```
3931
Logical visual description of processing steps for workflow
40-
```
4132

42-
---
4333

44-
# User guide
34+
## User guide
4535

46-
## Quick start guide
4736

48-
```
49-
General guide for deployment across multiple infrastructures (distinct from specific infrastructure quick start guide)
50-
```
37+
### Quick start guide
5138

52-
---
39+
> General guide for deployment across multiple infrastructures (distinct from specific infrastructure quick start guide)
5340
54-
## Infrastructure usage and recommendations
5541

56-
```
57-
+ link to installation instructions for each infrastructure
58-
+ recommendations
59-
60-
Documentation for a specific infrastructure should go into a infrastructure documentation template
61-
https://github.com/AustralianBioCommons/doc_guidelines/blob/master/infrastructure_optimisation.md
62-
```
42+
### Install instructions
6343

64-
---
6544

66-
## Compute resource usage across tested infrastructures
45+
### Dependencies
6746

68-
```
69-
Table with high level compute resource usage information for standalone runs or testing of specific versions on specific computational infrastructures.
70-
```
7147

72-
| Title | Version | Sample description | Wall time | Cores | Peak RAM in GB (requested) | Drive (GB) | HPC-HTC | If HPC-HTC is other, specify | Scheduler | Year-Month |
73-
| ----- | ------- | ------------------ | --------- | ----- | -------------------------- | ---------- | ------- | ---------------------------- | --------- | ---------- |
74-
| | | | | | | | | | | |
48+
### Required (minimum) inputs/parameters
7549

76-
---
50+
> The minimum inputs required for the workflow to run.
7751
78-
# Benchmarking
7952

80-
```
81-
Benchmarking for a specific infrastructure should go here: if this document is complicated it should go into a benchmarking template, or be provided elsewhere (e.g. Zenodo).
82-
```
53+
### Infrastructure usage and recommendations
8354

84-
---
55+
> + link to installation instructions for each infrastructure
56+
> + recommendations
57+
58+
> Documentation for a specific infrastructure should go into a infrastructure documentation template
59+
https://github.com/AustralianBioCommons/doc_guidelines/blob/master/infrastructure_optimisation.md
8560

86-
# Workflow summaries
87-
88-
## Metadata
89-
90-
```
91-
Example table below
92-
```
93-
94-
|metadata field | workflow_name / workflow_version |
95-
|-------------------|:---------------------------------:|
96-
|Version | workflow_version |
97-
|Maturity | stable |
98-
|Creators | workflow_author_1 |
99-
|Source | NA |
100-
|License | NA |
101-
|Workflow manager | NextFlow |
102-
|Container | None |
103-
|Install method | Manual |
104-
|GitHub | NA |
105-
|bio.tools | NA |
106-
|BioContainers | NA |
107-
|bioconda | NA |
10861

109-
---
62+
### Compute resource usage across tested infrastructures
11063

111-
## Component tools
64+
> Table with high level compute resource usage information for standalone runs or testing of specific versions on specific computational infrastructures.
11265
113-
```
114-
Example below
115-
```
116-
| Workflow element/tool name | Workflow element/tool version | Workflow element/tool dependencies | Workflow title |
117-
|--------------------------|-----------------------------|----------------------------------|----------------|
118-
|Tool 1 |See workflow version |Dependency/version |workflow_title |
119-
|Tool 2 |See workflow version |Dependency/version |workflow_title |
120-
|Tool 3 |See workflow version |Dependency/version |workflow_title |
121-
---
66+
| Title | Version | Sample description | Wall time | Cores | Peak RAM in GB (requested) | Drive (GB) | Compute system (e.g. Pawsey Setonix HPC, AWS) | Scheduler | Year-Month |
67+
| ----- | ------- | ------------------ | --------- | ----- | -------------------------- | ---------- | ------- | --------- | ---------- |
68+
| | | | | | | | | | |
12269

123-
## Required (minimum) inputs/parameters
12470

125-
```
126-
The minimum inputs required for the workflow to run.
127-
```
71+
### Benchmarking
12872

129-
---
73+
> Benchmarking for a specific infrastructure should go here: if this document is complicated it should go into a benchmarking template, or be provided elsewhere (e.g. Zenodo).
13074
131-
# Additional notes
13275

133-
---
76+
## Additional notes
13477

135-
# Help / FAQ / Troubleshooting
13678

137-
---
79+
## Help / FAQ / Troubleshooting
13880

139-
# 3rd party Tutorials
14081

141-
---
82+
## 3rd party Tutorials
14283

143-
# License(s)
14484

145-
---
85+
## License(s)
14686

147-
# Acknowledgements/citations/credits
14887

149-
```
150-
Any attribution information that is relevant to the workflow being documented.
151-
```
88+
## Acknowledgements/citations/credits
89+
90+
> Any attribution information that is relevant to the workflow being documented.
15291
153-
---

0 commit comments

Comments
 (0)