read.DeponsDynBatch: Read and merges DEPONS Batchmap and Statistics Files

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

Read and merges DEPONS Batchmap and Statistics Files

Description

Reads batch map files and statistics files from a specified directory and returns a list of 'DeponsDyn' objects and parameter values.

Usage

read.DeponsDynBatch(
  dir,
  par,
  title = "NA",
  landscape = "NA",
  simtime = "NA",
  startday = "NA",
  timestep = 30,
  tz = "UTC"
)

Arguments

dir	Character string specifying the directory path containing the 'Batchmap' and 'Statistics' files.
par	Character vector specifying the column names to extract from the batch map file for each run. #' These parameters are then stored in the 'Parameters' list.
title	Optional character string
landscape	Character string. Name of the simulation landscape. Default is "NA".
simtime	Optional character string with the date and time when the simulation finished (format yyyy-mm-dd).
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)
timestep	Time step used in the model, in minutes. Defaults to 30 in DEPONS.
tz	Timezone.

Value

A list of 'DeponsDyn' objects and parameter values associated with run id

Examples

## Not run: 
# Specify the directory containing Batchmap and Statistics files
dir_path <- "path/to/batchdata"

# Specify parameters to extract from Batchmap files
par <- c("parameter1", "parameter2")

# Run the function
results <- read.DeponsBatch(
  dir = dir_path,
  par = par,
  startday = "2010-01-01"
)

## End(Not run)

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