summarize_syneco: Summarize synthetic ecosystem for SPEW console output

In spew: SPEW Framework for Generating Synthetic Ecosystems

Description

Summarize synthetic ecosystem for SPEW console output

Usage

summarize_syneco(syneco, vars_to_sum_h, vars_to_sum_p, vars_to_sum_env = NULL,
  samp_size = 10^4, marginals = NULL, top_region_id = "Ecosystem",
  has_marg = FALSE)

Arguments

syneco	output from the 'spew' function
vars_to_sum_h	character vector of variables from the household data frame output to summarize
vars_to_sum_p	character vector of variables from the person data frame output to summarize
vars_to_sum_env	character vector of variables from the person data frame which correspond to environment assignments. Default is NULL.
samp_size	number of agents to retain from each lower-level region, for plotting purposes only. Default is 10^4.
marginals	list containing all of the marginal totals. See ?make_ipf_marg for more details.
top_region_id	Name supplied of region.
has_marg	Does the region of marginals to refer to? Logical. Default is FALSE.

Value

list with the household summary list, people summary list, header for households, and header for people, and a data frame of plotting coordinates by summary region

spew documentation built on Nov. 17, 2017, 7:36 a.m.