ranges: Calculates descriptive stats from the HexSim generated report...

In carlopacioni/HexSimR: An R Package For Post HexSim Simulation Analysis

Description

ranges calculates descriptive stats, for each year, from the HexSim generated report 'ranges'. In addition to HexSim items, ranges also calculates the mean number of groups and the mean size of territory in ha and sqkm based on the value passed with hx. From this table ranges then calculates the mean across all years in the window of years start - end.

Usage

ranges(rep.ranges = NULL, hx = NULL, events = NULL, start = "min", end = "max")

Arguments

rep.ranges	The fully qualified (i.e. including the path) name of the report
hx	The size of one hexagon in hectares
events	A character vector with the name of the events for which the mean and standard deviation across years needs to be calculated. If NULL (default), all events are considered
start	The first time step to be included
end	The last time step to be included

Value

A list with three elements:

• descriptive: A data.frame (data.table) with the summary statistics with mean for each time step, for each event

• means: A data.frame (data.table) with the mean across the selected time steps

• sds: A data.frame (data.table) with the standard deviation across the selected time steps

These results are also saved to disk in two files:

• descriptive_ranges.csv: The summary statistics for each time step, for each event

• summary_ranges.xlsx: the mean and standard deviation across the selected time steps (in two separate tabs)

carlopacioni/HexSimR documentation built on Nov. 28, 2020, 4:12 p.m.