Skip to content

Commit

Permalink
fix link
Browse files Browse the repository at this point in the history
  • Loading branch information
MeWu-IDM committed Sep 5, 2024
1 parent 512ad35 commit eebdfc2
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Design.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h2 class="anchored" data-anchor-id="code-structure-entensibility-and-limitation
<ul>
<li><p><b>app.R</b>: This serves as the main entry point for the Shiny application that defines the UI (ui), server logic (server). You should be able to start the app by running this script from Rstudio.</p></li>
<li><p><b>Global.R</b>: Contains global variables and functions accessible across both the UI and server, used for app settings and loading configuration files. It is a special script that is executed once when the Shiny app is launched, and before the ui and server components are created. In this script we handle downloading the template config file and loading the regional configuration files.</p></li>
<li><p><b>validation_report.Rmd</b> This serves as the validation report template, along with definition in config/validation/rules, it is used by ValidateInput.R to generate a validation report. This can be useful if you are modifying the config data and want to make sure it complies with the simulation engine. You can read more about the validate package (here)[<a href="https://cran.r-project.org/web/packages/validate/index.html" class="uri">https://cran.r-project.org/web/packages/validate/index.html</a>].</p></li>
<li><p><b>validation_report.Rmd</b> This serves as the validation report template, along with definition in config/validation/rules, it is used by ValidateInput.R to generate a validation report. This can be useful if you are modifying the config data and want to make sure it complies with the simulation engine. You can read more about the validate package <a href="https://cran.r-project.org/web/packages/validate/index.html">here</a>.</p></li>
<li><p><b>www folder</b>: Contains static assets like images, CSS files, and JavaScript files. These resources are served directly to the browser and can be referenced in the UI code. We have used Shinyjs package to run some custom javascript scripts, you can add more custom scripts to this folder.</p></li>
<li><p><b>R folder</b>: Stores R scripts with modules and functions used in Shiny app. Each module typically consists of a UI and server function, allowing for reusability and better organization. Example: A module for handling results plots can be found in <a href="https://github.com/InstituteforDiseaseModeling/PACE-HRH-UI/blob/main/R/plotTab.R">plotTab.R</a> In the MVP version, the app is following modular design but not perfectly refactored. It is recommend to further refactor the code to suit your customization.</p></li>
<li><p><b>config folder</b>: Contain configuration files used for the app, for more details, please go to the <a href="https://github.com/InstituteforDiseaseModeling/PACE-HRH-UI/blob/main/Configuration.md">Configuration guide</a></p></li>
Expand Down
2 changes: 1 addition & 1 deletion Design.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ graph TD

- <b>Global.R</b>: Contains global variables and functions accessible across both the UI and server, used for app settings and loading configuration files. It is a special script that is executed once when the Shiny app is launched, and before the ui and server components are created. In this script we handle downloading the template config file and loading the regional configuration files.

- <b>validation_report.Rmd</b> This serves as the validation report template, along with definition in config/validation/rules, it is used by ValidateInput.R to generate a validation report. This can be useful if you are modifying the config data and want to make sure it complies with the simulation engine. You can read more about the validate package (here)\[<https://cran.r-project.org/web/packages/validate/index.html>\].
- <b>validation_report.Rmd</b> This serves as the validation report template, along with definition in config/validation/rules, it is used by ValidateInput.R to generate a validation report. This can be useful if you are modifying the config data and want to make sure it complies with the simulation engine. You can read more about the validate package [here](https://cran.r-project.org/web/packages/validate/index.html).

- <b>www folder</b>: Contains static assets like images, CSS files, and JavaScript files. These resources are served directly to the browser and can be referenced in the UI code. We have used Shinyjs package to run some custom javascript scripts, you can add more custom scripts to this folder.

Expand Down

0 comments on commit eebdfc2

Please sign in to comment.