Updated documentation

- Updated .Rd files for functions using `roxygen2::roxygenise()`
- Edited examples for `run_fredi_sv()`

R/run_fredi_sv.R

@@ -49,7 +49,7 @@
 #'
 #' @examples
 #' ### Run SV Module with defaults without specifying sector
-#' df_sv <- run_fredi_sv()
+#' # df_sv <- run_fredi_sv()
 #'
 #' ### Return a character vector with the names of all of the sectors in the FrEDI SV Module:
 #' get_sv_sectorInfo()
@@ -67,16 +67,16 @@
 #' data(gcamScenarios)
 #'
 #' ### Load population scenario
-#' data(popDefault)
+#' data(popScenario)
 #'
 #' ### Run SV Module for "Extreme Temperature" with custom population and temperature scenarios
-#' df_sv <- run_fredi_sv(sector = "Extreme Temperature", inputsList = list(pop=popDefault, temp=gcamScenarios)
+#' df_sv <- run_fredi_sv(sector = "Extreme Temperature", inputsList=list(pop=popScenario, temp=gcamScenarios)
 #'
 #' ### Run SV Module for "Coastal Properties" with custom population and SLR scenarios
-#' df_sv <- run_fredi_sv(sector = "Coastal Properties", inputsList = list(pop=popDefault, slr=gcamScenarios)
+#' df_sv <- run_fredi_sv(sector = "Coastal Properties", inputsList=list(pop=popScenario, slr=gcamScenarios)
 #'
 #' ### Run SV Module for "Coastal Properties" with custom population and temperature scenarios
-#' df_sv <- run_fredi_sv(sector = "Coastal Properties", inputsList = list(pop=popDefault, temp=gcamScenarios)
+#' df_sv <- run_fredi_sv(sector = "Coastal Properties", inputsList=list(pop=popScenario, temp=gcamScenarios)
 #'
 #'
 #'
@@ -106,10 +106,10 @@ run_fredi_sv <- function(
     .testing    = FALSE
 ){
   ###### Set up the environment ######
-  pkgPath     <- NULL
-  pkgPath     <- (pkgPath |> is.null()) |> ifelse(system.file(package="FrEDI"), pkgPath);
-  rDataType   <- "rds"
-  impactsPath <- pkgPath |> file.path("extdata", "sv", "impactLists")
+  pkgPath       <- NULL
+  pkgPath       <- (pkgPath |> is.null()) |> ifelse(system.file(package="FrEDI"), pkgPath);
+  rDataType     <- "rds"
+  impactsPath   <- pkgPath |> file.path("extdata", "sv", "impactLists")
 
   ###### ** Load Data Objects ######
   ### Get FrEDI data objects
@@ -128,20 +128,20 @@ run_fredi_sv <- function(
 
   ### Group types
   c_svGroupTypes <- svDataList$c_svGroupTypes
-  minYear  <- minYear0
-  maxYear  <- maxYear0
-  yearsBy5 <- minYear |> seq(maxYear, by=5)
+  minYear    <- minYear0
+  maxYear    <- maxYear0
+  yearsBy5   <- minYear |> seq(maxYear, by=5)
 
   ### Testing
-  save    <- .testing |> ifelse(FALSE, save)
+  save       <- .testing |> ifelse(FALSE, save)
 
   ### Level of messaging (default is to message the user)
-  silent  <- (silent |> is.null()) |> ifelse(T, silent)
-  msgUser <- !silent
-  msg0    <- ""
-  msg1    <- msg0 |> paste0("\t")
-  msg2    <- msg1 |> paste0("\t")
-  msg3    <- msg2 |> paste0("\t")
+  silent     <- (silent |> is.null()) |> ifelse(T, silent)
+  msgUser    <- !silent
+  msg0       <- ""
+  msg1       <- msg0 |> paste0("\t")
+  msg2       <- msg1 |> paste0("\t")
+  msg3       <- msg2 |> paste0("\t")
 
   ###### ** State Columns ######
   byState    <- TRUE
@@ -239,7 +239,7 @@ run_fredi_sv <- function(
   idCols0      <- list(valCols0=valCols0, df0=inputDefs[inNames0]) |> pmap(function(valCols0, df0){
     df0 |> names() |> get_matches(y=valCols0, matches=F)
   }) |> set_names(inNames0)
-  valCols0 |> print(); idCols0 |> print()
+  # valCols0 |> print(); idCols0 |> print()
 
   ###### ** Valid Inputs & Input Info ######
   ### Figure out which inputs are not null, and filter to that list