Skip to content

Commit d5f8491

Browse files
enryHenryH
authored
Merge branch 'main' into fix_app
2 parents 186c371 + a610101 commit d5f8491

File tree

5 files changed

+67
-26
lines changed

5 files changed

+67
-26
lines changed

‎CITATION.cff‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ preferred-citation:
2828
given-names: "Alberto"
2929
orcid: "http://orcid.org/0000-0002-9163-7730"
3030
title: "VueGen: Automating the generation of scientific reports"
31-
journal: "bioRxiv"
31+
journal: "Bioinformatics Advances"
3232
year: 2025
33-
doi: "10.1101/2025.03.05.641152"
34-
url: "https://www.biorxiv.org/content/10.1101/2025.03.05.641152v1"
33+
doi: "10.1093/bioadv/vbaf149"
34+
url: "https://doi.org/10.1093/bioadv/vbaf149"

‎LICENSE‎ renamed to ‎LICENSE.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
MIT License
1+
## MIT License
22

3-
Copyright (c) 2023 Multi-omics Network Analytics Group
3+
Copyright (c) 2025 Multi-omics Network Analytics Group
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,13 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
SOFTWARE.
22+
23+
## Creative Commons Attribution 4.0 International License (CC BY 4.0)
24+
25+
Copyright (c) 2025 Multi-omics Network Analytics Group
26+
27+
The creative works from this project are licensed under a Creative Commons Attribution
28+
4.0 International License.
29+
30+
To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/.
31+

‎README.md‎

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
| Information | Links |
88
| :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| **Package** | [![PyPI Latest Release](https://img.shields.io/pypi/v/vuegen.svg)][vuegen-pypi] [![Conda Latest Release](https://img.shields.io/conda/v/bioconda/vuegen.svg)][vuegen-conda] [![Supported versions](https://img.shields.io/pypi/pyversions/vuegen.svg)][vuegen-pypi] [![Docker Repository on Quay](https://quay.io/repository/dtu_biosustain_dsp/vuegen/status "Docker Repository on Quay")][vuegen-docker-quay] [![License](https://img.shields.io/github/license/Multiomics-Analytics-Group/vuegen)][vuegen-license] |
10-
| **Documentation** | [![View - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=flat)][vuegen-docs] [![made-with-sphinx-doc](https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/) ![Docs](https://readthedocs.org/projects/vuegen/badge/?style=flat) |
9+
| **Package** | [![PyPI Latest Release](https://img.shields.io/pypi/v/vuegen.svg)][vuegen-pypi] [![Conda Latest Release](https://img.shields.io/conda/v/bioconda/vuegen.svg)][vuegen-conda] [![Supported versions](https://img.shields.io/pypi/pyversions/vuegen.svg)][vuegen-pypi] [![Docker Repository on Quay](https://quay.io/repository/dtu_biosustain_dsp/vuegen/status "Docker Repository on Quay")][vuegen-docker-quay] [![License](https://img.shields.io/github/license/Multiomics-Analytics-Group/vuegen)][vuegen-license]|
10+
| **Documentation** | [![View - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=flat)][vuegen-docs] [![made-with-sphinx-doc](https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/) ![Docs](https://readthedocs.org/projects/vuegen/badge/?style=flat) [![CC BY 4.0][cc-by-shield]][vuegen-license]|
1111
| **Build** | [![CI](https://github.com/Multiomics-Analytics-Group/vuegen/actions/workflows/cdci.yml/badge.svg)][ci-gh-action] [![Docs](https://github.com/Multiomics-Analytics-Group/vuegen/actions/workflows/docs.yml/badge.svg)][ci-docs] |
1212
| **Examples** | [![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)][emp-html-demo] [![Streamlit](https://img.shields.io/badge/Streamlit-%23FE4B4B.svg?style=for-the-badge&logo=streamlit&logoColor=white)][emp-st-demo] |
1313
| **Discuss on GitHub** | [![GitHub issues](https://img.shields.io/github/issues/Multiomics-Analytics-Group/vuegen)][issues] [![GitHub pull requests](https://img.shields.io/github/issues-pr/Multiomics-Analytics-Group/vuegen)][pulls] |
@@ -21,6 +21,7 @@
2121
- [GUI](#gui)
2222
- [Case studies](#case-studies)
2323
- [Web application deployment](#web-application-deployment)
24+
- [License](#license)
2425
- [Contributing](#contributing)
2526
- [Credits and acknowledgements](#credits-and-acknowledgements)
2627
- [Citation](#citation)
@@ -335,12 +336,24 @@ This advanced case study demonstrates the application of VueGen in a real-world
335336
> The EMP case study is available online as [HTML][emp-html-demo] and [Streamlit][emp-st-demo] reports.
336337
> The [configuration file][emp-config] is available in the `docs/example_config_files` folder, and the [directory][emp-dir] with example data is in the `docs/example_data` folder.
337338
338-
### 3. ChatBot Component
339+
### 3. APICall Component
340+
341+
This case study focuses on the `APICall` component, which enables interaction with external APIs by using HTTP methods such as **GET** and **POST**. The retrieved data is displayed in the report, allowing users to integrate external data sources into their anlyses. This component is restricted to **Streamlit** reports.
342+
343+
🔗 [![Open in Colab][colab_badge]][colab_link_apicall]
344+
345+
> [!NOTE]
346+
> A [configuration file example][apicall-config] for the apicall component is available in
347+
the `docs/example_config_files` folder.
348+
349+
### 4. ChatBot Component
339350

340351
This case study highlights VueGen’s capability to embed a chatbot component into a report subsection,
341352
enabling interactive conversations inside the report. This component is streamlit-specific and is not
342353
available for other report types.
343354

355+
🔗 [![Open in Colab][colab_badge]][colab_link_chatbot]
356+
344357
Two API modes are supported:
345358

346359
- **Ollama-style streaming chat completion:**
@@ -359,11 +372,11 @@ Two API modes are supported:
359372
- `links`: a list of source URLs (optional)
360373
- `HTML content`: an HTML snippet with a Pyvis network visualization (optional)
361374

362-
This response structure is currently customized for an internal knowledge graph assistant, but VueGen is being actively developed
363-
to support more flexible and general-purpose response formats in future releases.
375+
This response structure is currently customized for an internal knowledge graph assistant, but VueGen is being actively developed to support more flexible and general-purpose response formats in future releases.
364376

365377
> [!NOTE]
366-
> You can see a [configuration file example][config-chatbot] for the chatbot component in the `docs/example_config_files` folder.
378+
> A [configuration file example][chatbot-config] for the chatbot component is available
379+
in the `docs/example_config_files` folder.
367380

368381
## Web application deployment
369382

@@ -383,6 +396,14 @@ Run Streamlit apps directly in the browser with [stlite][stlite_repo], a WebAsse
383396

384397
These options provide flexibility depending on whether the goal is online accessibility, lightweight execution, or local application distribution.
385398

399+
## License
400+
401+
The code in this repository is licensed under the **MIT License**, allowing you to use, modify, and distribute it freely as long as you include the original copyright and license notice.
402+
403+
The documentation and other creative content are licensed under the **Creative Commons Attribution 4.0 International (CC BY 4.0) License**, meaning you are free to share and adapt it with proper attribution.
404+
405+
Full details for both licenses can be found in the [LICENSE][vuegen-license] file.
406+
386407
## Contributing
387408

388409
VueGen is an open-source project, and we welcome contributions of all kinds via GitHub issues and pull requests. You can report bugs, suggest improvements, propose new features, or implement changes. Please follow the guidelines in the [CONTRIBUTING](CONTRIBUTING.md) file to ensure that your contribution is easily integrated into the project.
@@ -428,7 +449,8 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
428449
[vuegen-conda]: https://anaconda.org/bioconda/vuegen
429450
[vuegen-docker-quay]: https://quay.io/repository/dtu_biosustain_dsp/vuegen
430451
[docker-folder]: https://github.com/Multiomics-Analytics-Group/nf-vuegen/tree/main/Docker
431-
[vuegen-license]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/LICENSE
452+
[vuegen-license]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/LICENSE.md
453+
[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg
432454
[vuegen-class-diag-att]: https://raw.githubusercontent.com/Multiomics-Analytics-Group/vuegen/main/docs/images/vuegen_classdiagram_withattmeth.pdf
433455
[vuegen-docs]: https://vuegen.readthedocs.io/
434456
[ci-gh-action]: https://github.com/Multiomics-Analytics-Group/vuegen/actions/workflows/cdci.yml
@@ -437,7 +459,6 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
437459
[emp-st-demo]: https://earth-microbiome-vuegen-demo.streamlit.app/
438460
[ollama_chat]: https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion
439461
[ollama]: https://ollama.com/
440-
[config-chatbot]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/Chatbot_example_config.yaml
441462
[issues]: https://github.com/Multiomics-Analytics-Group/vuegen/issues
442463
[pulls]: https://github.com/Multiomics-Analytics-Group/vuegen/pulls
443464
[vuegen-article]: https://doi.org/10.1093/bioadv/vbaf149
@@ -456,6 +477,10 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
456477
[emp]: https://earthmicrobiome.org/
457478
[emp-config]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/Earth_microbiome_vuegen_demo_notebook_config
458479
[emp-dir]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_data/Earth_microbiome_vuegen_demo_notebook
480+
[colab_link_apicall]: https://colab.research.google.com/github/Multiomics-Analytics-Group/vuegen/blob/main/docs/vuegen_apicall_case_study.ipynb
481+
[apicall-config]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/APIcall_example_config.yaml
482+
[colab_link_chatbot]: https://colab.research.google.com/github/Multiomics-Analytics-Group/vuegen/blob/main/docs/vuegen_chatbot_case_study.ipynb
483+
[chatbot-config]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/Chatbot_example_config.yaml
459484
[conda-download]: https://conda-forge.org/download/
460485
[gui-readme]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/gui/README.md
461486
[pyinstaller]: https://pyinstaller.org/

‎docs/images/logo/vuegen_logo_small.png‎

60 Bytes
Loading

0 commit comments

Comments
 (0)