get_metrics: Wrapper function to simplify workflow

Description Usage Arguments Value Examples

View source: R/quantile_estimation_functions_master.R

Description

Function will call other package functions to simplify the workflow of creating all aggregations for a scenario

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
get_metrics(
  config,
  srcdir,
  scenario,
  ifr_level,
  pattern_to_search,
  file_num,
  dest_dir,
  anchor_date = "2020-01-01",
  include_county = F,
  geoid_save_path = NULL
)

Arguments

config

for this aggregation

srcdir

a path to model output

scenario

a scenario name (character string)

ifr_level

a character string that indicates the ifr level (subset of parquet files)

file_num

number of source file on which to perform the aggregation (1000 for full set)

dest_dir

a path to save the aggregated files

include_county

a boolean (default is FALSE) indicating whether county level aggregation should be done

geoid_save_path

a string path where temp csvs should be stored if include_county is TRUE

anchor_data

a string data in form "YYYY-MM-DD" that indicates the first day of the model output (this defaults to "2020-01-01")

Value

Returns a datatable of county level aggregated information

Examples

1
2
3
config <- get_configuration(geoid_table)
get_metrics(config, "modeloutput/", "scenarioX", "med", 1000, "my_save_path/", "2020-01-01", include_county=F)
get_metrics(config, "modeloutput/", "scenarioX", "med", 1000, "my_save_path/", "2020-01-01", include_county=T, "tempfolder/")

lmullany/iddquantiles documentation built on June 21, 2020, 7:28 p.m.