R/parsing_functions.R

In fishsciences/ybt: Yolo Bypass Telemetry Project Analysis Package

#' Parse default-formatted Vemco Receiver column into two separate columns
#'@description separates the default Vemco column formatting of VR2W-RecSN, then just keeps the ReceiverSN as a new column
#'@param df dataframe with a `Receiver` column that is formatted as 'VRX-ReceiverSN' (i.e.,  must be delimited by hyphens)
#'@param reccol the name of the receiver column you wish to parse; defaults to "Receiver"
#'@return A dataframe with the `Receiver` column at the end, with the `VRX` info and hyphen removed.
#'@author Myfanwy Johnston
#'@details This function will not work on a column delimited by more than one hyphen
#'@export
#'@examples
#' df <- structure(list(TagID = c("A69-1206-112", "A69-1206-152", "A69-1206-1908"
#' ), Monitor = c("VR2W-106683", "VR2W-106683", "VR2W-106683"),
#'     Detections = c(1L, 1L, 1L)), row.names = c(NA, 3L), class = "data.frame")
#' parse_receiver_col(df, "Monitor")

parse_receiver_col <- function(df, reccol = "Receiver") {
  names(df)[names(df) == reccol] <- "SepRec" # rename the old combined tagid col
  out <- as.data.frame(do.call
                       (rbind, strsplit(as.character(df$SepRec),'-')),
                       stringsAsFactors = FALSE)

  colnames(out) <- c("freq", "Receiver")
  final <- cbind(df, out)
  drops <- c("freq", "SepRec")
  final <- final[ , !names(final) %in% drops]
  final$Receiver <- as.integer(final$Receiver)
  return(final)
  }


#' parse default-formatted Vemco tag column
#'@description separates the vemco-dictated column formatting of freq-codespace-tagid, then just keeps the codespace and tagids as separate columns
#'@param df dataframe with a transmitter column that is formatted as 'Freq-CodeSpace-Transmitter'
#'@param tagcol the name of the column you wish to parse
#'@param sepchar the character or symbol on which to split; defaults to '-'
#'@return A dataframe with the CodeSpace and TagID columns at the end, with frequency columns removed.
#'@export
#'@author Myfanwy Johnston
#' @examples
#' df <- structure(list(TagID = c("A69-1206-112", "A69-1206-152", "A69-1206-1908"
#' ), Monitor = c("VR2W-106683", "VR2W-106683", "VR2W-106683"),
#'     Detections = c(1L, 1L, 1L)), row.names = c(NA, 3L), class = "data.frame")
#' parse_tagid_col(df, "TagID")

parse_tagid_col <- function(df, tagcol = "TagID", sepchar = "-") {
  
  names(df)[names(df) == tagcol] = "SepTagID" # rename the old combined tagid col
  out = as.data.frame(do.call(rbind, 
                              strsplit(as.character(df$SepTagID), 
                                       split = sepchar)),
                      stringsAsFactors = FALSE)
  
  colnames(out) = c("freq", "CodeSpace", "TagID")
  final = cbind(df, out)
  drops = c("freq", "SepTagID")
  final = final[,!names(final) %in% drops]
  final$CodeSpace = as.integer(final$CodeSpace)
  final$TagID = as.integer(final$TagID)
  return(final)
  
}