Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
klau506 committed Mar 25, 2024
1 parent bdef64a commit 7dfc1c6
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 42 deletions.
24 changes: 0 additions & 24 deletions LICENSE

This file was deleted.

12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

# rfasstUI

A web-based interactive scenario builder and visualization application for the rfasst air pollution model
A web-based interactive scenario builder and visualization application for the [rfasst](https://github.com/bc3LC/rfasst)^1 air pollution model, an R version of the air quality reduced-form model [TM5-FASST](https://acp.copernicus.org/articles/18/16173/2018/)^2.

## Using `rfasstui`

Expand Down Expand Up @@ -50,9 +50,9 @@ collaborate!

For more information about contributing, please contact Clàudia Rodés-Bachs at claudia.rodes@bc3research.org or Jon Sampedro at jon.sampedro@bc3research.org

## Learn More About Rfasst
Read more about the Rfasst air pollution model here: [`rfasst` Documentation](https://bc3lc.github.io/rfasst/). `Rfasst` has been published in the following:
## Learn More About rfasst
Read more about the rfasst air pollution model here: [`rfasst` Documentation](https://bc3lc.github.io/rfasst/), detailed in [Sampedro et al. 2022](https://doi.org/10.21105/joss.03820). It is an R version of the TM5-FASST model, detailed in [Van Dingenen et al. 2018](https://doi.org/10.5194/acp-18-16173-2018)

```
Sampedro et al., (2022). rfasst: An R tool to estimate air pollution impacts on health and agriculture. Journal of Open Source Software, 7(69), 3820, https://doi.org/10.21105/joss.03820
```
- Sampedro et al., (2022). "rfasst: An R tool to estimate air pollution impacts on health and agriculture." Journal of Open Source Software, 7(69), 3820, https://doi.org/10.21105/joss.03820

- Van Dingenen, Rita, et al., (2018). "TM5-FASST: a global atmospheric source–receptor model for rapid impact analysis of emission changes on air quality and short-lived climate pollutants." Atmospheric Chemistry and Physics 18.21: 16173-16211.
11 changes: 7 additions & 4 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ pkgdown: 2.0.7
pkgdown_sha: ~
articles:
tutorial: tutorial.html
last_built: 2024-03-20T20:03Z
last_built: 2024-03-25T08:00Z
urls:
reference: https://bc3lc.github.io/gcamreport/reference
article: https://bc3lc.github.io/gcamreport/articles
Expand Down
2 changes: 1 addition & 1 deletion inst/rfasstui/rsconnect/shinyapps.io/bc3lc/rfasstui.dcf
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ account: bc3lc
server: shinyapps.io
hostUrl: https://api.shinyapps.io/v1
appId: 11517388
bundleId: 8399473
bundleId: 8399616
url: https://bc3lc.shinyapps.io/rfasstui/
version: 1
16 changes: 10 additions & 6 deletions inst/rfasstui/ui.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ fluidPage(theme = shinythemes::shinytheme("readable"),
agricultural damages, and economic losses attributable to air pollution using scenario outputs from the Global Change Analysis Model (GCAM).",
style = "float:left"),
p("This interactive version is built upon previous work including the development of the initial ",
a("rfasst R Package", href="https://github.com/bc3LC/rfasst/", target="blank"), "."),
a("rfasst R Package", href="https://github.com/bc3LC/rfasst/", target="blank"),
", which replicates the calculations of the air quality reduced-form model ",
a("TM5-FASST", href="https://doi.org/10.5194/acp-18-16173-2018", target="blank")),
style = "float: left"
)),
column(4, div(
Expand Down Expand Up @@ -293,22 +295,24 @@ fluidPage(theme = shinythemes::shinytheme("readable"),
h5("Documentation/Downloads"),
tags$hr(class="hrNav"),
p("The primary link to the rfasst model documentation is the ",
a("online manual", href="https://jgcri.github.io/rfasst/index.html", target="blank"),
a("online manual", href="https://bc3lc.github.io/rfasst/index.html", target="blank"),
", which is included in the vignettes/manual directory. The code is also documented with ",
a("Doxygen-style", href="http://doxygen.org", target="blank"),
" comments."),
p("A formal model description paper via ",
a("Sampedro et al. 2022", href="https://joss.theoj.org/papers/10.21105/joss.03820", target="blank")),
a("Sampedro et al. 2022", href="https://joss.theoj.org/papers/10.21105/joss.03820", target="blank"),
" and ",
a("Van Dingenen et al. 2018.", href="https://doi.org/10.5194/acp-18-16173-2018", target="blank")),
tags$ul(
tags$li(
h5(tags$a("rfasst User Interface package download/source link ", href="https://github.com/bc3LC/rfasstui", target="blank"))),
tags$li(
h5(tags$a("rfasst R package download/source link", href="https://github.com/bc3LC/rfasst", target="blank"))),
tags$li(
h5(tags$a("Code and data for rfasst", href="https://zenodo.org/records/7417835", target="blank"),
tags$img(src="https://zenodo.org/badge/DOI/10.5281/zenodo.344924589.svg", class="zenodo", alt="DOI")
)
)
tags$img(src="https://zenodo.org/badge/DOI/10.5281/zenodo.344924589.svg", class="zenodo", alt="DOI"))),
tags$li(
h5(tags$a("Theorical description of TM5-FASST", href="https://doi.org/10.5194/acp-18-16173-2018", target="blank")))
),
br(),
h5("Tools and software that work with rfasst"),
Expand Down

0 comments on commit 7dfc1c6

Please sign in to comment.