Skip to content

Commit f629e84

Browse files
committed
📝 Docs: update README with information about the VueGen nf-core module
1 parent 9093a2b commit f629e84

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The VueGen documentation is available at [vuegen.readthedocs.io][vuegen-docs], w
4242

4343
## Installation
4444
### 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:
4646

4747
```bash
4848
pip install vuegen
@@ -59,14 +59,14 @@ pip install -e . # in case your pwd is in the vuegen directory
5959
> 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`.
6060
6161
### 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:
6363

6464
```bash
6565
conda install bioconda::vuegen
6666
```
6767

6868
### 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:
7070

7171
```bash
7272
quarto check
@@ -78,6 +78,9 @@ quarto check
7878
### Docker
7979
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].
8080

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+
8184
## Execution
8285
> [!IMPORTANT]
8386
> 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
145148
These options provide flexibility depending on whether the goal is online accessibility, lightweight execution, or local application distribution.
146149

147150
## 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].
149152
- 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!
150153
- 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].
151154

@@ -191,6 +194,9 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
191194
[quarto]: https://quarto.org/
192195
[quarto-cli-pypi]: https://pypi.org/project/quarto-cli/
193196
[quarto-cli]: https://quarto.org/docs/get-started/
197+
[nfcore]: https://nf-co.re/
198+
[nextflow]: https://www.nextflow.io/
199+
[nf-vuegen]: https://github.com/Multiomics-Analytics-Group/nf-vuegen/
194200
[colab_badge]: https://colab.research.google.com/assets/colab-badge.svg
195201
[colab_link_intro_demo]: https://colab.research.google.com/github/Multiomics-Analytics-Group/vuegen/blob/main/docs/vuegen_basic_case_study.ipynb
196202
[colab_link_emp_demo]: https://colab.research.google.com/github/Multiomics-Analytics-Group/vuegen/blob/main/docs/vuegen_case_study_earth_microbiome.ipynb

0 commit comments

Comments
 (0)