pkgdown updates (code of conduct, typos)

FrEDI/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

FrEDI/_pkgdown.yml

@@ -18,24 +18,30 @@ navbar:
   left:
     - icon: fa-home fa-lg
       href: "index.html"
-#    - text: About
-#      href: "articles/About.html"
     - text: Getting Started
       menu:
        - text: "About FrEDI"
          href: articles/About.html
        - text: "Installing & Running FrEDI"
          href: articles/manual.html
+       - text: "Contributing to FrEDI"
+         href: articles/contributing.html
     - text: Documentation
       href: "articles/References.html"
     - text: Examples
       menu:
-        - text: "Example: Run with default parameters"
+        - text: "Example: Run FrEDI with default parameters"
           href: articles/Example1.html
+        - text: "Example: Run FrEDI_SV with default parameters"
+          href: articles/Example2.html
     - text: Functions
       href: "reference/index.html"
     - text: News
       href: "news/index.html"
+  right:
+    - icon: fa-github fa-lg
+      href: "https://github.com/USEPA/FrEDI"
+
 
 home:
   sidebar:

FrEDI/index.Rmd

@@ -24,3 +24,15 @@ FrEDI is an open-source, reduced complexity model that rapidly projects the impa
 FrEDI was developed to fill an important gap in assessing U.S. climate change impacts by incorporating a broad range of impact studies into a common, open-source framework. This allows FrEDI to facilitate comparability across impact studies, with the flexibility of facilitating custom scenario analyses. 
 
 FrEDI is continually developed and currently draws upon over 30 existing peer-reviewed studies, including from the [Climate Change Impacts and Risk Analysis (CIRA)](https://www.epa.gov/cira/) project, to estimate the relationship between future degrees of warming and impacts across more than 20 category sectors, 7 U.S. regions, and populations. When supplied with a user-defined temperature trajectory, FrEDI then applies these temperature-impact relationships to rapidly project annual climate change impacts and damages through the end of the 21st century.
+<br>
+
+
+**Recommended Citation:** EPA. 2021. Technical Documentation on the Framework for Evaluating Damages and Impacts (FrEDI). U.S. Environmental Protection Agency, EPA 430-R-21-004. Available at: https://www.epa.gov/cira/fredi.
+
+---
+**EPA Disclaimer**
+<br>
+
+The United States Environmental Protection Agency (EPA) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. EPA has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by EPA. The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government.
+
+By submitting a pull request to the GitHub and/or by installing this package, you make an agreement with EPA that you will not submit a claim of compensation for services rendered to EPA or any other federal agency. Further, you agree not to charge the time you spend developing software code related to this project to any federal grant or cooperative agreement.

FrEDI/index.md

@@ -21,4 +21,31 @@ the relationship between future degrees of warming and impacts across
 more than 20 category sectors, 7 U.S. regions, and populations. When
 supplied with a user-defined temperature trajectory, FrEDI then applies
 these temperature-impact relationships to rapidly project annual climate
-change impacts and damages through the end of the 21st century.
+change impacts and damages through the end of the 21st century. <br>
+
+**Recommended Citation:** EPA. 2021. Technical Documentation on the
+Framework for Evaluating Damages and Impacts (FrEDI). U.S. Environmental
+Protection Agency, EPA 430-R-21-004. Available at:
+<https://www.epa.gov/cira/fredi>.
+
+-----
+
+**EPA Disclaimer** <br>
+
+The United States Environmental Protection Agency (EPA) GitHub project
+code is provided on an “as is” basis and the user assumes responsibility
+for its use. EPA has relinquished control of the information and no
+longer has responsibility to protect the integrity, confidentiality, or
+availability of the information. Any reference to specific commercial
+products, processes, or services by service mark, trademark,
+manufacturer, or otherwise, does not constitute or imply their
+endorsement, recommendation or favoring by EPA. The EPA seal and logo
+shall not be used in any manner to imply endorsement of any commercial
+product or activity by EPA or the United States Government.
+
+By submitting a pull request to the GitHub and/or by installing this
+package, you make an agreement with EPA that you will not submit a claim
+of compensation for services rendered to EPA or any other federal
+agency. Further, you agree not to charge the time you spend developing
+software code related to this project to any federal grant or
+cooperative agreement.

FrEDI/vignettes/About.Rmd

@@ -56,7 +56,7 @@ FrEDI fills an important gap in assessing U.S. climate change impacts by:
 3. Providing a flexible framework that can readily incorporate new information, to ensure projections reflect the latest science on climate change impacts
 <br>
 
-**FrEDI draws upon a wide range of existing scientific literature.** FrEDI currently draws upon over 30 existing peer-reviewed studies and climate change impact models and uses an impacts-by-degree temperature binning approach [(Sarofim et al., 2021)](https://link.springer.com/article/10.1007/s10584-021-03048-6), to estimate the relationship between future degrees of warming and impacts across more than 20 impact category sectors [(Hartin et al., 2023)] (https://egusphere.copernicus.org/preprints/2023/egusphere-2023-114/). Many of these sectoral studies have been adapted from EPA’s [Climate Change Impacts and Risk Assessment (CIRA)](https://www.epa.gov/cira) project, which began in 2008 to assess and compare the impacts of climate change in the U.S. using a consistent set of climate models and socioeconomic scenarios. External studies (for example from CIL (https://impactlab.org/)) are now also integrated into FrEDI in cases where the underlying studies can provide regional physical or economic impacts by degree of warming (or cm of sea level rise) and can be scaled to account for future socioeconomic (e.g., GDP or population) or sector-specific (e.g., premature mortality) conditions. 
+**FrEDI draws upon a wide range of existing scientific literature.** FrEDI currently draws upon over 30 existing peer-reviewed studies and climate change impact models and uses an impacts-by-degree temperature binning approach [(Sarofim et al., 2021)](https://link.springer.com/article/10.1007/s10584-021-03048-6), to estimate the relationship between future degrees of warming and impacts across more than 20 impact category sectors ([Hartin et al., 2023](https://egusphere.copernicus.org/preprints/2023/egusphere-2023-114/)). Many of these sectoral studies have been adapted from EPA’s [Climate Change Impacts and Risk Assessment (CIRA)](https://www.epa.gov/cira) project, which began in 2008 to assess and compare the impacts of climate change in the U.S. using a consistent set of climate models and socioeconomic scenarios. External studies (for example from the [Climate Impacts Lab](https://impactlab.org/)) are now also integrated into FrEDI in cases where the underlying studies can provide regional physical or economic impacts by degree of warming (or cm of sea level rise) and can be scaled to account for future socioeconomic (e.g., GDP or population) or sector-specific conditions. 
 
 
 **FrEDI is peer-reviewed and developed as an open-source R package.** This Framework and its [Technical Documentation](https://www.epa.gov/cira/fredi) have been subject to a public review comment period and an independent external peer review, following guidance in the EPA Peer-Review Handbook for Influential Scientific Information (ISI). Information on the peer-review is available in the [EPA Science Inventory](https://cfpub.epa.gov/si/si_public_record_report.cfm?dirEntryId=351316&Lab=OAP&simplesearch=0&showcriteria=2&sortby=pubDate&searchall=fredi&timstype=&datebeginpublishedpresented=02/14/2021). 

FrEDI/vignettes/articles/Example2.Rmd

@@ -0,0 +1,22 @@
+---
+title: "Example #2"
+date: "June, 2023"
+description: >
+  Running & Analyzing results from FrEDI SV.
+#output: rmarkdown::html_vignette
+output: html_document
+#source: repo_source('FrEDI/', path_rel(input, paste0('FrEDI/',pkg$src_path))
+vignette: >
+  %\VignetteIndexEntry{Example #2}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r setup, include=FALSE}
+knitr::opts_chunk$set(echo = TRUE)
+```
+
+# Running FrEDI's Social Vulnerability Module
+
+Example coming soon 
+

FrEDI/vignettes/articles/contributing.Rmd

@@ -0,0 +1,21 @@
+---
+title: "Contributing to FrEDI"
+date: "June, 2023"
+description: >
+  How to Contribute to FrEDI.
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Contributing to FrEDI}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+
+More information coming soon.