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
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,7 +94,7 @@ VueGen is also available as a [nf-core][nfcore] module, customised for compatibi
94
94
## Execution
95
95
96
96
> [!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.
98
98
99
99
Run VueGen using a directory with the following command:
100
100
@@ -201,6 +201,9 @@ This introductory case study uses a predefined directory with plots, dataframes,
201
201
202
202
🔗 [![Open in Colab][colab_badge]][colab_link_intro_demo]
203
203
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
+
204
207
**2. Earth Microbiome Project Data**
205
208
206
209
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
209
212
210
213
> [!NOTE]
211
214
> 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.
212
216
213
217
**3. ChatBot Component**
214
218
@@ -312,8 +316,12 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
0 commit comments