mp.results: Calculates various endpoints using results from RAMAS MP...

Description Usage Arguments Details Value

View source: R/mp.results.r

Description

mp.results Calculates various endpoints from the results of an MP simulation as carried out in RAMAS. Use for Metapop version 5 and 5.1 file formats. Based on ResOut.exe program written by R. Akcakaya

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
mp.results(
  mpFile,
  spatial = FALSE,
  ptc = FALSE,
  ptcFiles = "no file",
  ptcFileIter = "",
  habdyn = FALSE,
  hdhFile = "no file",
  verbose = FALSE
)

Arguments

spatial

TRUE/FALSE - should spatial parameters be extracted from the *.mp file, including factors such as dispersal, correlation, and factors included in *.ptc files, if included

ptc

TRUE/FALSE - Is a *.ptc file included? If yes, some spatial information can be extracted from this file

ptcFiles

A single path to a ptc file or a vector of ptc files with which to extract data from.

ptcFileIter

For each ptcFile, the corresponding iteration as noted in the HabDyn history file. If no history file is used, iter values can be some user defined values, however an error will be generated if the length of ptcfiles and ptcFileIter do not match.

habdyn

TRUE/FALSE - Was HabDyn module used? Is there a corresponding HabDyn history file?

hdhFile

The full path name to the HabDyn history (.txt) file

verbose

Print function progress and checkpoints.

mpList

The full list object of an MP file that has been run (i.e., has results)

Details

The resulting data.frame includes several parameters and endpoints. Each is discribed below.

Value

res.summ.df A data frame of the endpoints calculated.


mlammens/demgsa documentation built on Aug. 4, 2020, 1:16 a.m.