Show an example of a community report - e.g., in or linked from "basics" vignette
#344 opened on May 28, 2026
Repository metrics
- Stars
- (2 stars)
- PR merge metrics
- (PR metrics pending)
Description
There should be an easily found, nice looking community report somewhere in the documentation prominently. The new pdf format reports should be shown somewhere. Documentation for latest version released is at https://public-environmental-data-partners.github.io/EJAM, and gets built using the pkgdown package (workflow gh action or EJAM:::pkgdown_update().
One place it could go or get linked to from is the vignette (article) on the basics of using EJAM.
The EJAM/vignettes/basics.Rmd vignette showed an example of a rendered community report or summary report, but it was commented out / turned off because there was a problem. The better approach is the pdf report can be stored in the repository and they can be linked to as a standalone report using the links in the comment below.
UPDATE:
We should try to save the file in, say, www/ and use an API-type URL for this. Would require redeploying API. The API should be able to serve static assets from the root or any path, such as:
www/EPA_logo_white_2.png
Example:
https://ejamapi-84652557241.us-central1.run.app/www/EPA_logo_white_2.png
OLDER NOTES / MAYBE OBSOLETE:
To link to a file that was in the app/www folder of a release that has been installed for the hosted web app, this works for example:
Link to any docs in inst/app/www for just the currently hosted version of EJAM: https://ejam.policyinnovation.info/www/user-guide-2025-02.pdf but only after it is hosted there and only for that version of the file, while you might want to be able to see report examples from different versions.
Link to docs on GitHub in a specific branch - works fine for pdf that are shown as readable and for html if using a helper like EJAM::url_github_preview()
EJAM::url_github_preview(file="testoutput_ejam2report_10pts_1miles.html")
which returns by default a way to see a file in the inst/testdata/examples_of_output/ folder:
"https://htmlpreview.github.io/?https://github.com/Public-Environmental-Data-Partners/EJAM/blob/main/inst/testdata/examples_of_output/testoutput_ejam2report_10pts_1miles.html"
or .pdf files now have been put at links shown in comment below.
fyi `a few reports also were archived here at one point: inst/report/community_report and some were here as html inst/testdata/examples_of_output/
Pushed changes to dev to save those pdf files there, and to update those files any release needs to rerun the scripts that would do that, for each release version, in files like
data-raw/datacreate_.*testoutput