TrimSummary: TrimSummary

In KamilSJaron/ConjunctionStats: The parser of simulations of hybrid zones performed by simulator Conjunction (http://github.com/KamilSJaron/Conjunction)

Description

TrimSummary integrates the the output of ReadSummary and ReadSetting functions into a list of data.frame objects. Warning: choose this function if Conjunction simulation was run in a 1D world; choose alternative function Trim2DSummary instead if Conjunction simulation was run in a 2D world.

Usage

TrimSummary(sim, centers)

Arguments

sim	A string of characters indicating a ReadSummary object. Please refer to documentation of ReadSummary function for detailed usage.
centers	A string of characters indicating a center variable of ReadSetting object. Please refer to documentation of ReadSetting function for detailed usage.

Value

A data.frame object, integrating information about the settings used in the simulation run and the summary of the simulation run in a R-friendly format.

Author(s)

Kamil Jaron kamiljaron at gmail.com

Examples

{
   mySim=ReadSummary(nameIn='../../Conjunction/out')
   myReadSetting=ReadSetting(InputFile='../../Conjunction/setting.txt')
   myCenters=myReadSetting$C
   myTrimSummary = TrimSummary(sim=mySim, centers=myCenters)
}

KamilSJaron/ConjunctionStats documentation built on May 7, 2019, 12:06 p.m.