summarize_spew: Summarize a SPEW region

In leerichardson/spew: SPEW Framework for Generating Synthetic Ecosystems

Description

Summarize a SPEW region

Usage

summarize_spew(filenames, marginals = NULL, vars_to_sum, env_vars = NULL,
  coords = TRUE, samp_size = 10^4, read = FALSE, pops = NULL,
  type = NULL)

Arguments

filenames	list of full path to files to summarize and the id of the region
marginals	list containing all of the marginal totals. See ?make_ipf_marg for more details. Default is NULL
vars_to_sum	variables we wish to summarize, should correspond to marginals object
env_vars	environment variables to summarize. Default is NULL
coords	logical of whether to extract the longitude/latitude coordinates and store
samp_size	number of lon/lat coordinates to sample. Default is 10^4
read	logical of whether we need to read in the populations. Default is FALSE
pops	list of the populations produced by SPEW for a household OR people
type	either NULL, "households", or "people".

Value

a list of length of 1 for the region ID , 1 for population size, and optionally one for a dataframe of stored lat/long coords, the number of variables to summarize , and the environmental variables

leerichardson/spew documentation built on May 21, 2019, 1:39 a.m.