Skip to content

Commit 05d36ee

Browse files
committed
📝 Docs: add links to cong and folders for the case studies
1 parent 4fa76f8 commit 05d36ee

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ VueGen is also available as a [nf-core][nfcore] module, customised for compatibi
9494
## Execution
9595

9696
> [!IMPORTANT]
97-
> 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.
97+
> Here we use the `Earth_microbiome_vuegen_demo_notebook` [directory][emp-dir] and the `Earth_microbiome_vuegen_demo_notebook.yaml` [configuration file][emp-config] 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.
9898
9999
Run VueGen using a directory with the following command:
100100

@@ -201,6 +201,9 @@ This introductory case study uses a predefined directory with plots, dataframes,
201201

202202
🔗 [![Open in Colab][colab_badge]][colab_link_intro_demo]
203203

204+
> [!NOTE]
205+
> The [configuration file][predef-dir-config] is available in the `docs/example_config_files` folder, and the [directory][predef-dir] with example data is in the `docs/example_data` folder.
206+
204207
**2. Earth Microbiome Project Data**
205208

206209
This advanced case study demonstrates the application of VueGen in a real-world scenario using data from the [Earth Microbiome Project (EMP)][emp]. The EMP is an initiative to characterize global microbial taxonomic and functional diversity. The notebook process the EMP data, create plots, dataframes, and other components, and organize outputs within a directory to produce reports. Report content and structure can be adapted by modifying the configuration file. Each report consists of sections on exploratory data analysis, metagenomics, and network analysis.
@@ -209,6 +212,7 @@ This advanced case study demonstrates the application of VueGen in a real-world
209212

210213
> [!NOTE]
211214
> The EMP case study is available online as [HTML][emp-html-demo] and [Streamlit][emp-st-demo] reports.
215+
> 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.
212216
213217
**3. ChatBot Component**
214218

@@ -312,8 +316,12 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
312316
[nf-vuegen]: https://github.com/Multiomics-Analytics-Group/nf-vuegen/
313317
[colab_badge]: https://colab.research.google.com/assets/colab-badge.svg
314318
[colab_link_intro_demo]: https://colab.research.google.com/github/Multiomics-Analytics-Group/vuegen/blob/main/docs/vuegen_basic_case_study.ipynb
319+
[predef-dir-config]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/Basic_example_vuegen_demo_notebook_config.yaml
320+
[predef-dir]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_data/Basic_example_vuegen_demo_notebook
315321
[colab_link_emp_demo]: https://colab.research.google.com/github/Multiomics-Analytics-Group/vuegen/blob/main/docs/vuegen_case_study_earth_microbiome.ipynb
316322
[emp]: https://earthmicrobiome.org/
323+
[emp-config]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/Earth_microbiome_vuegen_demo_notebook_config
324+
[emp-dir]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_data/Earth_microbiome_vuegen_demo_notebook
317325
[st-cloud]: https://streamlit.io/cloud
318326
[stlite]: https://github.com/whitphx/stlite
319327
[st-forum-exe]: https://discuss.streamlit.io/t/streamlit-deployment-as-an-executable-file-exe-for-windows-macos-and-android/6812

0 commit comments

Comments
 (0)