get_cam_op: Get camera operation matrix

In inbo/camtraptor: Read, Explore and Visualize Camera Trap Data Packages

Get camera operation matrix

Description

Returns the camera operation matrix as returned by camtrapR::cameraOperation().

Usage

get_cam_op(
  package = NULL,
  ...,
  station_col = "locationName",
  camera_col = NULL,
  session_col = NULL,
  use_prefix = FALSE,
  datapkg = lifecycle::deprecated()
)

Arguments

package	Camera trap data package object, as returned by read_camtrap_dp().
...	filter predicates for filtering on deployments.
station_col	Column name to use for identifying the stations. Default: "locationName".
camera_col	Column name of the column specifying Camera ID. Default: NULL.
session_col	Column name to use for identifying the session. Default: NULL. Use it for creating multi-session / multi-season detection histories.
use_prefix	Logical (TRUE or FALSE). If TRUE the returned row names will start with prefix "Station" as returned by camtrapR::cameraOperation(). Default: FALSE.
datapkg	Deprecated. Use package instead.

Details

The deployment data are by default grouped by locationName (station ID in camtrapR jargon) or another column specified by the user via the station_col argument. If multiple deployments are linked to same location, daily efforts higher than 1 occur.

Partially active days, e.g. the first or the last day of a deployment, result in decimal effort values as in camtrapR::cameraOperation().

Value

A matrix. Row names always indicate the station ID. Column names are dates.

See Also

Other exploration functions: get_custom_effort(), get_effort(), get_n_individuals(), get_n_obs(), get_n_species(), get_rai(), get_rai_individuals(), get_record_table(), get_scientific_name(), get_species()

Examples

library(dplyr)
get_cam_op(mica)

# Applying filter(s) on deployments, e.g. deployments with latitude >= 51.18
get_cam_op(mica, pred_gte("latitude", 51.18))

# Specify column with station names
get_cam_op(mica, station_col = "locationID")

# Specify column with session IDs
mica_sessions <- mica
mica_sessions$data$deployments <- mica_sessions$data$deployments %>%
  dplyr::mutate(session = ifelse(
    stringr::str_starts(.data$locationName, "B_DL_"),
      "after2020",
      "before2020"
  )
)
get_cam_op(mica_sessions, session_col = "session")

# Specify column with camera IDs
mica_cameras <- mica_sessions
mica_cameras$data$deployments$cameraID <- c(1, 2, 3, 4)
get_cam_op(mica_cameras, camera_col = "cameraID")

# Specify both session and camera IDs
get_cam_op(mica_cameras, camera_col = "cameraID", session_col = "session")

# Use prefix Station as in camtrapR's camera operation matrix
get_cam_op(mica, use_prefix = TRUE)

inbo/camtraptor documentation built on June 2, 2025, 5:17 a.m.