format_org {telemetR}

Format Organism Data for add_org()

Description

This function takes a dataframe of org and tag data and renames the columns to those expected by the add_org() function

Usage

format_org(
  data,
  var_Id,
  var_release,
  var_tag_life,
  var_ping_rate,
  local_time_zone,
  time_format
)

Arguments

data

a dataframe of org and tag data

var_Id

the column name, in quotes, which identifies the individual transmitter/tag/organism identifier.

var_release

the column name, in quotes, which identifies the release date and time in POSIX format and appropriate timezone

var_tag_life

the column name, in quotes, which identified the expected tag life in days

var_ping_rate

the column name, in quotes which identifies the expected ping rate of the tag/transmitter

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_org() function

Examples

# Rename columns to work with functions
format_org(data = fish,
            var_Id = "TagCode",
            var_release = "Release_Date",
            var_tag_life = "TagLife",
            var_ping_rate = "PRI",
            local_time_zone = "America/Los_Angeles",
            time_format = "%Y-%m-%d %H:%M:%S")