read.DeponsBlockdyn: Reading simulated population count for blocks

In jacobnabe/DEPONS2R: Read, Plot and Analyse Output from the DEPONS Model

Reading simulated population count for blocks

Description

Function for reading DEPONS simulation output with number of animals per block for each time step.

Usage

read.DeponsBlockdyn(
  fname,
  title = "NA",
  landscape = "NA",
  simtime = "NA",
  timestep = 30,
  startday = "2010-01-01",
  tz = "UTC"
)

Arguments

fname	Name of the file (character) that contains movement data generated by DEPONS. The name includes the path to the directory if this is not the current working directory.
title	Optional character string giving name of simulation
landscape	The landscape used in the simulation
simtime	Optional text string with date of simulation (format: yyyy-mm-dd). If not provided this is obtained from name of input file
timestep	Time step used in the model, in minutes. Default 30 minutes
startday	The start of the period that the simulation represents, i.e. the real-world equivalent of 'tick 1' (character string of the form 'yyyy-mm-dd', or POSIXlt). Default "2010-01-01"
tz	Time zone. In DEPONS times are generally assumed to be in "UTC" (Coordinated Universal Time).

Value

DeponsBlockdyn object

See Also

See DeponsBlockdyn-class for details on what is stored in the output object and read.DeponsParam for reading the parameters used in the simulation.

Examples

## Not run: 
# File loaded from default location
the.file <- "/Applications/DEPONS 2.1/DEPONS/PorpoisePerBlock.2020.Sep.02.20_24_17.csv"
file.exists(the.file)
porpoise.blockdyn <- read.DeponsBlockdyn(fname=the.file,
  title="Test simulation with two blocks", landscape="North Sea")
porpoise.blockdyn

# Get the latest simulation
the.file <- get.latest.sim(type="blockdyn", dir="/Applications/DEPONS 2.1/DEPONS")
owd <- getwd()
setwd("/Applications/DEPONS 2.1/DEPONS")
porpoise.blockdyn <- read.DeponsBlockdyn(fname=the.file)
setwd(owd)

## End(Not run)

jacobnabe/DEPONS2R documentation built on Jan. 26, 2025, 9:33 a.m.