Merge pull request #193 from USEPA/io_updates_eem

Github page updates for v4.1

FrEDI/DESCRIPTION

@@ -1,6 +1,6 @@
 Package: FrEDI
 Title: The Framework for Evaluating Damages and Impacts (FrEDI)
-Version: 4.1.0
+Version: 4.1.1
 Authors@R: c(person("Corinne", "Hartin",
                     email   = "[email protected]",
                     role    = c("aut","cre"),
@@ -11,6 +11,11 @@ Authors@R: c(person("Corinne", "Hartin",
                      role    = c("aut","ctb"),
                      comment = c(ORCID = "0000-0002-6845-6077",
                                  github = "emcduffie")),
+             person("Marcus","Sarofim",
+                     email   = "[email protected]",
+                     role    = c("aut","ctb"),
+                     comment = c(ORCID = "0000-0001-7753-1676",
+                                 github = "emcduffie")),
              person("Karen","Noiva",
                      role    = c("aut","ctb"),
                      comment = c(ORCID = "0000-0002-4412-5302", 

FrEDI/NEWS.md

@@ -1,3 +1,53 @@
+# FrEDI v4.1.1
+
+_See FrEDI v4.1 for full release notes_
+
+* Bug fixes - n/a
+* Updates - 
+** Major updates: n/a
+** Minor updates include: updated the `includeaggregate` flag for the suicide sector in `run_fredi()` and `run_fredi_sv()`, to alert users of an alternative sector aggregation approach to avoid possible double counting with the impacts in the default temperature-related mortality sector; updated R package documentation to reflect updates; updated github page
+* Additional sectors added - n/a
+* Documentation fixes - n/a
+* New features - n/a
+
+# FrEDI v4.1
+
+This release corresponds to FrEDI v4.1, which accompanies the publication of the 2024 FrEDI Technical Documentation.
+
+* Bug fixes - n/a
+* Updates -
+** Major updates: impacts and damages now calculated at the state-level (previously region-level) for all 25 impact-category sectors; FrEDI default max year was changed from 2090 to 2100
+** Minor updates include: updated import_inputs() to accept population datafiles containing U.S. national, contiguous U.S., or U.S. state populations and set temperature values outside the allowed range (<=0C and >= 30C) to zero; updated run_fredi_sv() to accept state-level population inputs; updated R package documentation to reflect new features
+* Additional sectors added - n/a
+* Documentation fixes - minor updates to account for new default max year and state-level population input formatting features
+* New features - FrEDI outputs include damages and impacts at the state-level (48 contiguous states and the District of Columbia) for all 25 impact category sectors; FrEDI default max year was changed from 2090 to 2100
+
+# FrEDI v4.0.2 (peer-review)
+
+Starting in February 2024, the FrEDI Technical Documentation and v4.0 of the FrEDI R package will be subject to a public review comment period and independent, external peer-review.
+This release corresponds to FrEDI v4.0.2, the peer-review release version.
+
+* Bug fixes - fixes to GDP input reference in and meta data documentation in run_fredi()
+* Updates -
+** Major updates include: impacts and damages now calculated at the state-level (previously region-level) for 17 impact-category sectors
+** Minor updates include: n/a
+* Additional sectors added - n/a
+* Documentation fixes - n/a
+* New features - FrEDI outputs include damages and impacts at the state-level (48 contiguous states and the District of Columbia) for 17 impact category sectors.
+
+# FrEDI v4.0.1 (public review)
+
+Starting in February 2024, the FrEDI Technical Documentation and v4.0 of the FrEDI R package will be subject to a public review comment period and independent, external peer-review.
+This release corresponds to FrEDI v4.0.1, the public comment release version.
+
+* Bug fixes - file paths in function documentation for run_fredi(), import_inputs(), and aggregate_impacts(); income elasticity for SLR sectors post-2090 in run_fredi() (no longer dependent on argument elasticity)
+* Updates -
+** Major updates include: impacts and damages now calculated at the state-level (previously region-level) for 12 impact-category sectors; population inputs for `run_fredi()` now requires state-level population instead of region-level inputs; damage function extrapolation approach for warmer temperatures for `run_fredi()` and `run_fredi_sv()`; default income elasticity (argument `elasticity` in `run_fredi()`) from 0.4 to 1.0; updated `run_fredi()` user inputs to remove options to calculate present values (arguments `pv`, `rate`, `baseYear`) and add option to output intermediate calculation columns
+** Minor updates include: `magrittr` pipe operator `%>%` to the native pipe operator `|>`; Added monitoring of default `run_fredi()` parameter use; output columns from `aggregate_impacts` (added columns `“sectorprimary”` and `“includeaggregate”` for all aggregation levels and added columns `“physical_impacts”`, `“physicalmeasure”` for all aggregation levels except `aggLevels=”impacttype”`); removed option to output `run_fredi_sv()` module results to an Excel template
+* Documentation fixes - this version corresponds to the February 2024 version of the FrEDI Technical Documentation (see https://www.epa.gov/cira/about-fredi). Function documentation updated to correspond to updates.
+* Additional sectors added - n/a
+* New features - FrEDI outputs include damages and impacts at the state-level (48 contiguous states and the District of Columbia) for 12 impact category sectors.
+
 # FrEDI v3.4
 
 * Bug fixes - minor fixes to inputs used in run_fredi() and run_fredi_sv()

FrEDI/_pkgdown.yml

@@ -52,6 +52,6 @@ footer:
     left: developed_by
     right: [built_with, date]
   components:
-    date: "| July 2023"
+    date: "| August 2024"
 
 #destination: ../docs/

FrEDI/index.Rmd

@@ -19,15 +19,15 @@ knitr::opts_chunk$set(echo = TRUE)
 
 This repository is for FrEDI, the **Framework for Evaluating Damages and Impacts**, developed by the U.S. Environmental Protection Agency (EPA).
 
-FrEDI is an open-source, reduced complexity model that rapidly projects the impacts of climate change within the United States, under any custom temperature or policy pathway. 
+FrEDI is an open-source, reduced form model that rapidly projects the impacts of climate change within the United States, under any custom temperature or policy pathway. 
 
 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.
+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, 48 U.S. states plus the District of Columbia, and population groups. 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 (optionally through the year 2300).
 <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.
+**Recommended Citation:** EPA 2024. Technical Documentation for the Framework for Evaluating Damages and Impacts (FrEDI). U.S. Environmental Protection Agency, EPA 430-R-24-001. Available at: https://www.epa.gov/cira/fredi.
 
 ---
 <font size="2"> 

FrEDI/index.md

@@ -4,7 +4,7 @@
 This repository is for FrEDI, the **Framework for Evaluating Damages and
 Impacts**, developed by the U.S. Environmental Protection Agency (EPA).
 
-FrEDI is an open-source, reduced complexity model that rapidly projects
+FrEDI is an open-source, reduced form model that rapidly projects
 the impacts of climate change within the United States, under any custom
 temperature or policy pathway.
 
@@ -18,14 +18,14 @@ 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>
+more than 20 category sectors, 48 U.S. states plus the District of Columbia, 
+and population groups. 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
+**Recommended Citation:** EPA 2024. Technical Documentation on the
 Framework for Evaluating Damages and Impacts (FrEDI). U.S. Environmental
-Protection Agency, EPA 430-R-21-004. Available at:
+Protection Agency, EPA 430-R-24-001. Available at:
 <https://www.epa.gov/cira/fredi>.
 
 -----