acdc_access: Short-cuts to elements of an '"acdc_record"' object

acdc_accessR Documentation

Short-cuts to elements of an "acdc_record" object

Description

These functions provide short-cuts to elements of an acdc_record-class object.

Usage

acdc_access_dat(record)

acdc_access_timesteps(record)

acdc_access_maps(
  record,
  type = c("map_timestep", "map_cumulative"),
  select = NULL
)

Arguments

record

An acdc_record-class object.

type

For acdc_access_maps, type is a character that specifies whether or not to access time step-specific maps (type = "map_timestep") or cumulative maps (type = "map_cumulative").

select

(optional) For acdc_access_maps, select is an integer vector that defines the cumulative time steps (i.e., accounting for both primary (acoustic) and secondary (archival) time steps) for which maps are required.

Details

  • acdc_access_dat accesses the record$dat elements of an acdc_record-class object for all time steps.

  • acdc_access_timesteps accesses the total number of time steps stored in an acdc_record-class object, accounting for both primary (acoustic) and secondary (archival) time steps.

  • acdc_access_maps accesses all, or specified, maps from the record$spatial elements of an acdc_record-class object.

Value

  • acdc_access_dat returns a single dataframe for all time steps.

  • acdc_access_timesteps returns an integer that defines the total number of time steps.

  • acdc_access_maps returns a single list of time-step specific or cumulative maps for specified or all time steps.

Author(s)

Edward Lavender

Examples

#### Example (1): acdc_access_dat()
acdc_access_dat(acdc_simplify(dat_acdc))

#### Example (2): acdc_access_timesteps()
acdc_access_timesteps(acdc_simplify(dat_acdc))

#### Example (3): acdc_access_maps()
acdc_access_maps(acdc_simplify(dat_acdc))


edwardlavender/flapper documentation built on Jan. 22, 2025, 2:44 p.m.