-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME.qmd
43 lines (32 loc) · 2.05 KB
/
README.qmd
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
---
title: "Viash: A meta-framework for building reusable workflow modules"
format: gfm
---
[{width="300px"}](https://viash.io)
[](https://github.com/viash-io/viash/releases)
[](https://viash.io)
[](https://doi.org/10.21105/joss.06089)
[](https://github.com/viash-io/viash/actions/workflows/sbt_test.yml)
[](https://github.com/viash-io/viash/blob/master/LICENSE.md)
Viash helps you turn a script (Bash/R/Python/Scala/JavaScript) into a
reusable component. By providing some meta-data regarding its
functionality, a runner and an engine on which you want to run the software,
Viash can help you:
* Wrap your script in an executable with a CLI and --help functionality,
* Seamlessly execute your component natively on the host platform or in a Docker container
* Combine multiple components in a Nextflow pipeline, and
* Unit-test your component to ensure that it works at all times.
## Documentation
The Viash documentation is available online at [`viash.io`](https://viash.io).
## License
Copyright (C) 2020 Data Intuitive
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.