Merge pull request #171 from USEPA/pop_downscaling_kmn

SV documentation edits, state-level outputs

FrEDI/DESCRIPTION

@@ -1,6 +1,6 @@
 Package: FrEDI
 Title: The Framework for Evaluating Damages and Impacts (FrEDI)
-Version: 4.0.1
+Version: 4.1.0
 Authors@R: c(person("Corinne", "Hartin",
                     email   = "[email protected]",
                     role    = c("aut","cre"),

FrEDI/R/FrEDI-package.R

@@ -41,12 +41,12 @@
 #' * __help__ and __html__. Contain documentation for functions available to the user, including function descriptions, lists of arguments and outputs, and examples. See `"html/00Index.html"` or the individual R help functions for more information about individual functions.
 #' * __Meta__. Contains RDS files (ending in `".rds"`) with information about the package contents.
 #' * __extdata__. __extdata/scenarios__ Contains four CSV files for users to test the function for importing data. For more information on importing scenarios for use with [FrEDI::run_fredi()], refer to documentation for the function [FrEDI::import_inputs()].
-#'      * `"GCAM_scenario.csv"` contains a set of temperature scenarios that can be used with FrEDI, including the default temperature scenario used by both [FrEDI::run_fredi()] and [FrEDI::run_fredi_sv()] (labeled `"description="Hector_GCAM_v5.3_ECS_3.0_REF"` in `"slr_from_GCAM.csv"` and `"ECS_3.0_ref_0"` in the [FrEDI::gcamScenarios] dataset)). Also see the documentation for the [FrEDI::gcamScenarios] dataset for more information.
-#'      * `"State ICLUS Population.csv"` and `"Region ICLUS Population.csv"` contain the default population scenarios used by [FrEDI::run_fredi()] and [FrEDI::run_fredi_sv()], respectively (see [FrEDI::popScenario] and [FrEDI::popScenario_sv]).
+#'      * `"GCAM_scenario.csv"` contains a set of temperature scenarios that can be used with FrEDI, including the default temperature scenario used by both [FrEDI::run_fredi()] and [FrEDI::run_fredi_sv()]. Also see documentation for the [FrEDI::gcamScenarios] dataset for more information.
+#'      * `"State ICLUS Population.csv"` contains the default state population scenario used by [FrEDI::run_fredi()] (see [FrEDI::popScenario] and [FrEDI::popScenario_sv]).
 #'      * `"slr_from_GCAM.csv"` contains global mean sea level rise heights in centimeters (created from the reference temperature scenario).
 #'  * __extdata/sv__ Contains files used by the `FrEDI` SV module to calculate impacts.
 #'
-#' The `FrEDI` package contains a loadable dataset with default results `defaultResults`, which contains annual impacts produced by [FrEDI::run_fredi()] for the with the default options and default scenarios (i.e., default temperature, GDP, and state population trajectories). Other loadable datasets provided by FrEDI are a set of driver scenarios ([FrEDI::gcamScenarios]), a state population scenario ([FrEDI::popScenario]) for use with [FrEDI::run_fredi()] or [FrEDI::import_inputs()], and a regional population scenario (`popScenario_sv`) for use with [FrEDI::run_fredi_sv()]. These data can be loaded into the workspace using the `data()` function.
+#' The `FrEDI` package contains a loadable dataset with default results `defaultResults`, which contains annual impacts produced by [FrEDI::run_fredi()] for the with the default options and default scenarios (i.e., default temperature, GDP, and state population trajectories). Other loadable datasets provided by FrEDI are a set of driver scenarios ([FrEDI::gcamScenarios]) and a state population scenario ([FrEDI::popScenario]) for use with [FrEDI::run_fredi()] or [FrEDI::run_fredi_sv()], which can be loaded into the workspace using the `data()` function (e.g., `data(gcamScenarios)`).
 #'
 #' Typical use will involve `library(FrEDI)` or `require(FrEDI)`.
 #'

FrEDI/R/data.R

@@ -3,7 +3,7 @@
 #
 #' A dataframe containing the default outputs of [FrEDI::run_fredi()]
 #
-#' @format A data frame with 775,179 rows and 20 columns:
+#' @format A data frame with 1,501,500 rows and 20 columns:
 #' \describe{
 #'   \item{sector}{Name of the associated sector.}
 #'   \item{variant}{Name of the associated variant or adaptation (values are sector-specific).}
@@ -36,7 +36,7 @@
 #'
 #' The scenarios in this dataframe were created using [Hector](https://jgcri.github.io/hector/), an open-source, reduced-form global carbon-cycle climate model (Hartin et al., 2015) to model temperatures associated with emissions scenarios from the Global Change Analysis Model v5.3 (GCAM). The Global Change Analysis Model v5.3 ([GCAM](https://gcims.pnnl.gov/modeling/gcam-global-change-analysis-model)) is an open source model that represents the linkages between energy, water, land, climate and economic systems (Calvin et al., 2019).
 #'
-#' These temperature scenarios have the original global temperatures. Users must convert to CONUS temperatures using the [FrEDI::convertTemps] (with argument `from="global"`) before passing the scenarios to [FrEDI::run_fredi()] or [FrEDI::run_fredi_sv()]. *Please note that the `gcamScenarios` should be subset to any of the individual scenarios specified in the `scenario` column before passing to [FrEDI::run_fredi()] (e.g., `gcamScenarios |> dplyr::filter(scenario=="ECS_3.0_ref_0")` for the reference scenario).
+#' These temperature scenarios have the original global temperatures. Users must convert to CONUS temperatures using the [FrEDI::convertTemps] (with argument `from = "global"`) before passing the scenarios to [FrEDI::run_fredi()] or [FrEDI::run_fredi_sv()]. *Please note that the `gcamScenarios` should be subset to any of the individual scenarios specified in the `scenario` column before passing to [FrEDI::run_fredi()] (e.g., `gcamScenarios |> dplyr::filter(scenario=="Hector_GCAM_v5.3_ECS_3.0_REF")` for the default scenario).
 #'
 #' Calvin, K., Patel, P., Clarke, L., et al. 2019. GCAM v5.1: representing the linkages between energy, water, land, climate, and economic systems, Geosci. Model Dev., 12:677–698. https://doi.org/10.5194/gmd-12-677-2019.
 #'