R/class-glatos_animals.r

In jsta/glatos: A package for the Great Lakes Acoustic Telemetry Observation System

#' Constructor function for the class glatos_animals
#' 
#' @description
#' Constructor function for the class glatos_animals. Currently barebones 
#' and only used inside read_glatos_workbook.
#'
#' @param x A data.frame or data.table created from a standard GLATOS 
#' workbook file.
#' 
#' @return A data.frame of class \code{glatos_animals}:
#'
#' @note
#' This function may be developed in the future to dictate conversion 
#' constuction from a data frame. 

glatos_animals <- function(x)  {

  #coerce to data.frame if not
  if(inherits(x, "data.table")) x <- as.data.frame(x)
  if(!inherits(x, "data.frame")) stop("x must be data.frame")
  
  #add new class as first but keep existing (e.g., data.frame)
  class(x) <- c("glatos_animals", class(x))
  
  return (x)
}