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
+38Lines changed: 38 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,6 +83,15 @@ quarto check
83
83
> [!TIP]
84
84
> If quarto is not installed, you can download the command-line interface from the [Quarto website][quarto-cli] for your operating system.
85
85
86
+
For PDF reports, you need to have a LaTeX distribution installed. This can be done with quarto using the following command:
87
+
88
+
```bash
89
+
quarto install tinytex
90
+
```
91
+
92
+
> [!TIP]
93
+
> Also, you can add the `--quarto_checks` argument to the VueGen command to check and install the required dependencies automatically.
94
+
86
95
### Docker
87
96
88
97
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 images are available at [quay.io/dtu_biosustain_dsp/vuegen][vuegen-docker-quay]. The Dockerfiles to build the images are available [here][docker-folder].
> By default, the `streamlit_autorun` argument is set to False, but you can use it in case you want to automatically run the streamlit app.
107
116
117
+
### Folder structure
118
+
119
+
Your input directory must follow a **nested folder structure**, where first-level folders are treated as **sections** and second-level folders as **subsections**, containing the components (plots, tables, networks, Markdown text, and HTML files).
120
+
121
+
Here is an example layout:
122
+
```
123
+
report_folder/
124
+
βββ section1/
125
+
β βββ subsection1/
126
+
β βββ table.csv
127
+
β βββ image1.png
128
+
β βββ chart.json
129
+
βββ section2/
130
+
β βββ subsection1/
131
+
β β βββ summary_table.xls
132
+
β β βββ network_plot.graphml
133
+
β βββ subsection2/
134
+
β βββ report.html
135
+
β βββ summary.md
136
+
```
137
+
138
+
> [!WARNING]
139
+
> VueGen currently requires each section to contain at least one subsection folder. Defining only sections (with no subsections) or using deeper nesting levels (i.e., sub-subsections) will result in errors. In upcoming releases, we plan to support more flexible directory structures.
140
+
141
+
The titles for sections, subsections, and components are extracted from the corresponding folder and file names, and afterward, users can add descriptions, captions, and other details to the configuration file. Component types are inferred from the file extensions and names.
142
+
The order of sections, subsections, and components can be defined using numerical suffixes in folder and file names.
143
+
108
144
It's also possible to provide a configuration file instead of a directory:
If a configuration file is given, users can specify titles and descriptions for sections and subsections, as well as component paths and required attributes, such as file format and delimiter for dataframes, plot types, and other details.
0 commit comments