Skip to content

Commit

Permalink
Publishing EJAM for installation
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Silverman committed Jan 7, 2025
0 parents commit 802ca90
Show file tree
Hide file tree
Showing 2,291 changed files with 365,072 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
^.*\.Rproj$
^\.Rproj\.user$
^.*ALL_THIS_GETS_MOVED_TO_ROOT_FOLDER.*
^doc$
^Meta$
^data-raw$
^_pkgdown\.yml$
^docs$
^pkgdown$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
50 changes: 50 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master, development]
pull_request:
branches: [main, master, development]
release:
types: [published]
workflow_dispatch:

name: pkgdown.yaml

permissions: read-all

jobs:
pkgdown:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
steps:
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::.
needs: website

- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/[email protected]
with:
clean: false
branch: gh-pages
folder: docs
61 changes: 61 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# History files
.Rhistory
.Rapp.history

# Session Data files and any .rda file accidentally saved in the root folder
.RData
/*.rda

# User-specific files
.Ruserdata

# Example code in package build process
*-Ex.R

# Output files from R CMD build
/*.tar.gz

# Output files from R CMD check
/*.Rcheck/

# RStudio files
.Rproj.user/
/.Rproj.user
*.pper

# produced vignettes - but be sure these actually should be ignored ****
vignettes/*.html
vignettes/*.pdf

# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
.httr-oauth

# knitr and R markdown default cache directories
*_cache/
/cache/

# Temporary files created by R markdown
*.utf8.md
*.knit.md

# R Environment Variables
.Renviron
*.Rproj
inst/doc
packrat/lib*/
*.dcf
# such as EJAM/rsconnect/rstudio-connect.dmap-stage.aws.epa.gov/..../ejam.dcf configuration file for deplying to RStudio Connect server

/doc/
/Meta/

# large datasets stored as .arrow
/data/*.arrow

# pkgdown folders are here. I think if publishing from docs folder
# we do not want to ignore changes in it, despite default in what
# use_pkgdown(): creates a pkgdown config file and adds relevant files or directories to .Rbuildignore and .gitignore

# docs


27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing Guide

## Note on "EJAM" versus "EJAM-open" as the repository name

Please note that as of January 2025, changes are still being made to exactly where the open source project will be shared, documented, and available for contributions (such as submitting Issues or Pull Requests on GitHub). In the short term, it is important to note that the "EJAM" package is shared at the "EJAM-open" repository even though the documentation website still refers to and tries to link to a different, nonpublic repository called "EJAM" which may cause some confusion. An interim solution is to clone and work with the EJAM-open repository and just avoid using any weblinks pointing to USEPA/EJAM rather than USEPA/EJAM-open. The open source EJAM package was initially made available via the [EJAM-open repository](https://github.com/USEPA/EJAM-open), but the [EJAM package documentation](https://usepa.github.io/EJAM/index.html) was initially published from a non-public development repository, so that documentation's links to source code did not work (because they required access to a separate, non-public repository).

## Welcome!

We’re so glad you’re thinking about contributing to an EPA open source project!
If you’re unsure about anything, just ask — or submit your issue or pull request anyway.
The worst that can happen is we’ll politely ask you to change something.
We appreciate all friendly contributions.

We encourage you to read about this R package and project, and see the project’s
[CONTRIBUTING](https://usepa.github.io/EJAM/CONTRIBUTING.html) policy (this page),
[LICENSE](https://usepa.github.io/EJAM/LICENSE.html), and
[README](https://usepa.github.io/EJAM/index.html).

All contributions to this project will be released under the MIT dedication
or the CCO-1.0 license file dedication.

By submitting a pull request or issue, you are agreeing
to comply with this waiver of copyright interest.

If you have any questions or want to read more, check out the
[EPA Open Source Project Repo](https://github.com/USEPA/open-source-projects) and
[EPA's Interim Open Source Code Guidance](https://developer.epa.gov/guide/open-source-code/).
91 changes: 91 additions & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
Package: EJAM
Title: EJAM Environmental Justice Analysis Multisite tool
Version: 2.32.0
Author: Mark Corrales <[email protected]>
Maintainer: Mark Corrales <[email protected]>
License: MIT + file LICENSE.md
Description: Web app and R tools to easily summarize
demographics and environmental indicators
for residents in or near a large number of areas or specific sites.
Sites can be specified in a variety of ways - coordinates, facility IDs,
type of facility, shapefile, or Census areas.
Very fast identification of nearby blocks and distances, and
aggregation of indicators within each distance by site and overall.
EJScreen indicators are included.
URL: https://usepa.github.io/EJAM, https://github.com/USEPA/EJAM
Depends:
R (>= 2.10)
Imports:
arrow,
attempt,
collapse,
config (>= 0.3.1),
data.table,
DBI,
desc,
doSNOW,
dplyr,
DT,
foreach,
ggplot2,
ggridges,
glue,
golem (>= 0.3.3),
hrbrthemes,
htmltools,
leaflet,
leaflet.extras2,
magrittr,
methods,
openxlsx,
pdist,
pins,
piggyback,
pkgload,
readxl,
rhandsontable,
rmarkdown,
RMySQL,
SearchTrees,
shinydisconnect,
sf,
shiny (>= 1.7.2),
shinycssloaders,
shinyjs,
sp,
tidyr,
tidyverse,
viridis,
webshot
Suggests:
knitr,
spelling,
testthat (>= 3.0.0),
AOI,
beepr,
datasets,
fipio,
htmlwidgets,
jsonlite,
leaflet.extras,
mapview,
rnaturalearth,
rvest,
terra,
tidygeocoder,
units
Remotes:
mikejohnson51/AOI
Config/testthat/edition: 3
Encoding: UTF-8
LazyData: true
Language: en-US
VignetteBuilder: knitr, rmarkdown
RoxygenNote: 7.3.2
Roxygen: list(markdown = TRUE)
Config/testthat/parallel: false
EJScreenVersion: 2.32
EJScreenReleaseDate: 2024-08-12
ACSVersion: 2018-2022
ACSReleaseDate: 2023-12-07
CensusVersion: 2020
9 changes: 9 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# MIT License

Copyright (c) 2022 U.S. Federal Government (in countries where recognized)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Loading

0 comments on commit 802ca90

Please sign in to comment.