generated from openproblems-bio/task_template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
_viash.yaml
88 lines (77 loc) · 3.43 KB
/
_viash.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
viash_version: 0.9.0
# Step 1: Change the name of the task.
# example: task_name_of_this_task
name: task_template
organization: openproblems-bio
version: dev
license: MIT
# Step 2: Add keywords to describe the task.
keywords: [single-cell, openproblems, benchmark]
# Step 3: Update the `task_template` to the name of the task from step 1.
links:
issue_tracker: https://github.com/openproblems-bio/task_template/issues
repository: https://github.com/openproblems-bio/task_template
docker_registry: ghcr.io
# Step 4: Update the label, summary and description.
# A unique, human-readable, short label. Used for creating summary tables and visualisations.
label: Template
summary: A one sentence summary of purpose and methodology. Used for creating an overview tables.
description: |
Provide a clear and concise description of your task, detailing the specific problem it aims
to solve. Outline the input data types, the expected output, and any assumptions or constraints.
Be sure to explain any terminology or concepts that are essential for understanding the task.
Explain the motivation behind your proposed task. Describe the biological or computational
problem you aim to address and why it's important. Discuss the current state of research in
this area and any gaps or challenges that your task could help address. This section
should convince readers of the significance and relevance of your task.
# A list of references to relevant literature. Each reference should be a DOI or a bibtex entry
references:
doi:
- 10.21203/rs.3.rs-4181617/v1
# bibtex:
# - |
# @article{doe_2021_template,
# doi = {10.21203/rs.3.rs-4181617/v1},
# url = {https://doi.org/10.21203/rs.3.rs-4181617/v1},
# author = {Doe, John},
# title = {A template for creating new tasks},
# publisher = {Research Square},
# year = {2021},
# }
info:
image: The name of the image file to use for the component on the website.
# Step 5: Replace the task_template to the name of the task.
test_resources:
- type: s3
path: s3://openproblems-data/resources_test/task_template/
dest: resources_test/task_template
- type: s3
path: s3://openproblems-data/resources_test/common/
dest: resources_test/common
# Step 6: Update the authors of the task.
authors:
# Full name of the author, usually in the name of FirstName MiddleName LastName.
- name: John Doe
# Role of the author. Possible values:
#
# * `"author"`: Authors who have made substantial contributions to the component.
# * `"maintainer"`: The maintainer of the component.
# * `"contributor"`: Authors who have made smaller contributions (such as code patches etc.).
roles: [ "author", "maintainer" ]
# Additional information on the author
info:
github: johndoe
orcid: 0000-0000-0000-0000
email: [email protected]
twitter: johndoe
linkedin: johndoe
# Step 7: Remove all of the comments of the steps you completed
# Step 8: High five yourself!
config_mods: |
.runners[.type == "nextflow"].config.labels := { lowmem : "memory = 20.Gb", midmem : "memory = 50.Gb", highmem : "memory = 100.Gb", lowcpu : "cpus = 5", midcpu : "cpus = 15", highcpu : "cpus = 30", lowtime : "time = 1.h", midtime : "time = 4.h", hightime : "time = 8.h", veryhightime : "time = 24.h" }
repositories:
- name: core
type: github
repo: openproblems-bio/core
tag: build/main
path: viash/core