Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,5 @@ docs/images/Graphical_abstract/
docs/images/Nfcore_module_figure
docs/presentations/
docs/example_data/Earth_microbiome_vuegen_demo_notebook_test/
docs/vuegen_case_study_earth_microbiome test.ipynb
docs/vuegen_case_study_earth_microbiome_test.ipynb
test.py
71 changes: 64 additions & 7 deletions docs/vuegen_case_study_earth_microbiome.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,18 @@
"metadata": {},
"outputs": [],
"source": [
"# Install required libraries\n",
"%pip install vuegen cartopy seaborn biom-format"
"# Vuegen library \n",
"%pip install vuegen"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# Libraries for the notebook\n",
"%pip install cartopy seaborn biom-format"
]
},
{
Expand Down Expand Up @@ -1355,7 +1365,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### 4.2. HTML report"
"### 4.2. Revealjs report"
]
},
{
Expand All @@ -1364,7 +1374,30 @@
"metadata": {},
"outputs": [],
"source": [
"report_type = \"html\"\n",
"report_type = \"revealjs\"\n",
"report_name = \"Earth_microbiome_vuegen_demo_notebook_dir\"\n",
"\n",
"# Initialize logger\n",
"logger = get_logger(f\"{report_type}_report_{report_name}\")\n",
"\n",
"# Generate the report\n",
"report_generator.get_report(dir_path = base_output_dir, report_type = report_type, logger = logger)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### 4.3. HTML report"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"report_type = \"hml\"\n",
"report_name = \"Earth_microbiome_vuegen_demo_notebook_dir\"\n",
"\n",
"# Initialize logger\n",
Expand Down Expand Up @@ -1540,7 +1573,31 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### 5.6. HTML report with the extended configuration file"
"### 5.6. Revealjs report with the extended configuration file"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# Test the changes by generarating the report from the modified YAML file\n",
"report_type = \"revealjs\"\n",
"report_name = \"Earth_microbiome_vuegen_demo_notebook_config_extended\"\n",
"\n",
"# Initialize logger\n",
"logger = get_logger(f\"{report_type}_report_{report_name}\")\n",
"\n",
"# Generate the report\n",
"report_generator.get_report(config_path = config_path, report_type = report_type, logger = logger)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### 5.7. HTML report with the extended configuration file"
]
},
{
Expand All @@ -1563,7 +1620,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "vuegen",
"display_name": "vuegen-IFxaxej_-py3.12",
"language": "python",
"name": "python3"
},
Expand All @@ -1577,7 +1634,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.21"
"version": "3.12.6"
}
},
"nbformat": 4,
Expand Down
4 changes: 2 additions & 2 deletions src/vuegen/quarto_reportview.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ def _create_yaml_header(self) -> str:
<footer class="footer">
This report was generated with
<a href="https://github.com/Multiomics-Analytics-Group/vuegen" target="_blank">
<img src="../docs/images/vuegen_logo.svg" alt="VueGen" width="65px">
<img src="https://raw.githubusercontent.com/Multiomics-Analytics-Group/vuegen/main/docs/images/vuegen_logo.svg" alt="VueGen" width="65px">
</a>
| © 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">Multiomics Network Analytics Group (MoNA)</a>
</footer>""",
Expand Down Expand Up @@ -218,7 +218,7 @@ def _create_yaml_header(self) -> str:
<footer class="footer">
This report was generated with
<a href="https://github.com/Multiomics-Analytics-Group/vuegen" target="_blank">
<img src="../docs/images/vuegen_logo.svg" alt="VueGen" width="65px">
<img src="https://raw.githubusercontent.com/Multiomics-Analytics-Group/vuegen/main/docs/images/vuegen_logo.svg" alt="VueGen" width="65px">
</a>
| © 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">Multiomics Network Analytics Group (MoNA)</a>
</footer>""",
Expand Down
2 changes: 1 addition & 1 deletion src/vuegen/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -738,7 +738,7 @@ def generate_footer() -> str:
<footer class="footer">
This report was generated with
<a href="https://github.com/Multiomics-Analytics-Group/vuegen" target="_blank">
<img src="../../docs/images/vuegen_logo.svg" alt="VueGen" width="65px">
<img src="https://raw.githubusercontent.com/Multiomics-Analytics-Group/vuegen/main/docs/images/vuegen_logo.svg" alt="VueGen" width="65px">
</a>
| © 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
Multiomics Network Analytics Group (MoNA)
Expand Down
Loading