format_receivers {telemetR}

Format for Receiver data for filteRjsats

Description

This function takes a dataframe of receiver metadata and reformats specific columns so that they can be read by the filtering functions in filteRjsats package

Usage

format_receivers(
  data,
  var_receiver_serial,
  var_receiver_make,
  var_receiver_deploy,
  var_receiver_retrieve,
  local_time_zone,
  time_format
)

Arguments

data

the detection dataframe with columns for individual receivers, tag IDs,datetime, and the expected ping rate.

var_receiver_serial

the column name, in quotes, which identifies the serial number of the detection receiver

var_receiver_make

the column name, in quotes, which identifies the make or brand of the detection receiver. Must be one of "ATS", "Lotek", or "Tekno"

var_receiver_deploy

the column name, in quotes, which identifies the date and time the receiver was deployed

var_receiver_retrieve

the column name, in quotes, which identifies the date and time the receiver was retrieved

local_time_zone

the local timezone used for analyses. Uses tz database names (e.g. "America/Los_Angeles" for Pacific Time)

time_format

a string value indicating the datetime format of all time fields

Value

A dataframe which contains fields renamed to match those required by add_receivers() function

Examples

# Rename columns to work with functions
format_receivers(data = receivers,
                 var_receiver_serial = "receiver_serial_number",
                 var_receiver_make = "receiver_make",
                 var_receiver_deploy = "receiver_start",
                 var_receiver_retrieve = "receiver_end",
                 local_time_zone = "America/Los_Angeles",
                 time_format = "%m-%d-%Y %H:%M:%S")