You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ The VueGen documentation is available at [vuegen.readthedocs.io][vuegen-docs], w
42
42
43
43
## Installation
44
44
### Pip
45
-
Vuegen is available on [PyPI][vuegen-pypi] and can be installed using pip:
45
+
VueGen is available on [PyPI][vuegen-pypi] and can be installed using pip:
46
46
47
47
```bash
48
48
pip install vuegen
@@ -59,14 +59,14 @@ pip install -e . # in case your pwd is in the vuegen directory
59
59
> It is recommended to install VueGen inside a virtual environment to manage depenendencies and avoid conflicts with existing packages. You can use the virtual environment manager of your choice, such as `poetry`, `conda`, or `pipenv`.
60
60
61
61
### Conda
62
-
Vuegen is also available on [Bioconda][vuegen-conda] and can be installed using conda:
62
+
VueGen is also available on [Bioconda][vuegen-conda] and can be installed using conda:
63
63
64
64
```bash
65
65
conda install bioconda::vuegen
66
66
```
67
67
68
68
### Dependencies
69
-
Vuegen uses [Quarto][quarto] to generate various report types. The pip insallation includes quarto using the [quarto-cli Python library][quarto-cli-pypi]. To test if quarto is installed in your computer, run the following command:
69
+
VueGen uses [Quarto][quarto] to generate various report types. The pip insallation includes quarto using the [quarto-cli Python library][quarto-cli-pypi]. To test if quarto is installed in your computer, run the following command:
70
70
71
71
```bash
72
72
quarto check
@@ -78,6 +78,9 @@ quarto check
78
78
### Docker
79
79
If you prefer not to install VueGen on your system, a pre-configured Docker container is available. It includes all dependencies, ensuring a fully reproducible execution environment. See the [Execution section](#execution) for details on running VueGen with Docker. The official Docker image is available at [quay.io/dtu_biosustain_dsp/vuegen][vuegen-docker-quay].
80
80
81
+
### Nextflow and nf-core
82
+
VueGen is also available as a [nf-core][nfcore] module, customised for compatibility with the [Nextflow][nextflow] environment. This module is designed to automate report generation from outputs produced by other modules, subworkflows, or pipelines. The code and documentation for the nf-core module are available in the [nf-VueGen repository][nf-vuegen].
83
+
81
84
## Execution
82
85
> [!IMPORTANT]
83
86
> Here we use the `Earth_microbiome_vuegen_demo_notebook` directory and the `Earth_microbiome_vuegen_demo_notebook.yaml` configuration file as examples, which are available in the `docs/example_data` and `docs/example_config_files` folders, respectively. Make sure to clone this reposiotry to access these contents, or use your own directory and configuration file.
@@ -145,7 +148,7 @@ Once a Streamlit report is generated, it can be deployed as a web application to
145
148
These options provide flexibility depending on whether the goal is online accessibility, lightweight execution, or local application distribution.
146
149
147
150
## Credits and acknowledgements
148
-
-Vuegen was developed by the [Multiomics Network Analytics Group (MoNA)][Mona] at the [Novo Nordisk Foundation Center for Biosustainability (DTU Biosustain)][Biosustain].
151
+
-VueGen was developed by the [Multiomics Network Analytics Group (MoNA)][Mona] at the [Novo Nordisk Foundation Center for Biosustainability (DTU Biosustain)][Biosustain].
149
152
- VueGen relies on the work of numerous open-source projects like [Streamlit](streamlit), [Quarto][quarto], and others. A big thank you to their authors for making this possible!
150
153
- The vuegen logo was designed based on an image created by [Scriberia][scriberia] for The [Turing Way Community][turingway], which is shared under a CC-BY licence. The original image can be found at [Zenodo][zenodo-turingway].
151
154
@@ -191,6 +194,9 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
0 commit comments