multi.reports: Generate summary statistics for multiple reports

Description Usage Arguments Value See Also

View source: R/HexSimR.R

Description

multi.reports is basically a wrapper for the two functions that process HexSim generated reports. It assumes that the names of the report files were not changed from defaults and that each report was generated in a similar fashion. That is, either they are all generated from a combined log file, or they are generated from each iteration's log file. It reads the reports in each of the scenario's folder (or iteration subfolders) and process them as using either move or ranges.

If the reports file is generated from each iteration's log file, then the reports are sitting within each iteration's subfolder and path.results has to point to the scenario's folder (i.e. the subfolders will be the scenario's name with the suffix [x], where x is the number of the iteration).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
multi.reports(
  path.results = NULL,
  scenarios = "all",
  pop.name = NULL,
  type = "move",
  all = TRUE,
  hx = NULL,
  events = NULL,
  start = "min",
  end = "max"
)

Arguments

path.results

The path to the 'Results' folder

scenarios

A character vector with the scenarios to be processed or "all"

pop.name

The name of the population

type

Whether movement ("move") or ranges ("ranges") reports should be processed

all

Whether the reports were generated from a combined log file

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 where each element is the output from either move or ranges.

See Also

move, ranges


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