Commit 9cd5e6cd authored by Chris Holbrook's avatar Chris Holbrook

update constructor function help

parent e6ff9d14
......@@ -10,13 +10,8 @@
#' @return A data.frame of class \code{glatos_animals}:
#'
#' @note
#' This function may be expanded in the future to dictate conversion
#' between various data sources (glatos, otn, other) and versions to
#' a single 'glatos_animals' standard format. One way to do this might
#' be to (1) specify name_in, name_out, and type_in, type_out eg in the
#' schema data files, (2) use "..." argument to this constructor function to
#' allow each standard column to be mapped directly from source, and (3)
#' check that requirements are met.
#' This function may be developed in the future to dictate conversion
#' constuction from a data frame.
glatos_animals <- function(x) {
......
......@@ -2,7 +2,7 @@
#'
#' @description
#' Constructor function for the class glatos_detections. Currently barebones
#' and only used inside read_glatos_detections.
#' and only used inside read_glatos_detections and read_otn_detections.
#'
#' @param x A data.frame or data.table created from a standard glatos
#' detection file.
......@@ -10,13 +10,8 @@
#' @return A data.frame of class \code{glatos_detections}:
#'
#' @note
#' This function may be expanded in the future to dictate conversion
#' between various data sources (glatos, otn, other) and versions to
#' a single 'glatos_detection' standard format. One way to do this might
#' be to (1) specify name_in, name_out, and type_in, type_out eg in the
#' schema data files, (2) use "..." argument to this constructor function to
#' allow each standard column to be mapped directly from source, and (3)
#' check that requirements are met.
#' This function may be developed in the future to dictate conversion
#' constuction from a data frame.
glatos_detections <- function(x) {
......
......@@ -9,13 +9,8 @@
#' @return A data.frame of class \code{glatos_receivers}:
#'
#' @note
#' This function may be expanded in the future to dictate conversion
#' between various data sources (glatos, otn, other) and versions to
#' a single 'glatos_detection' standard format. One way to do this might
#' be to (1) specify name_in, name_out, and type_in, type_out eg in the
#' schema data files, (2) use "..." argument to this constructor function to
#' allow each standard column to be mapped directly from source, and (3)
#' check that requirements are met.
#' This function may be developed in the future to dictate conversion
#' constuction from a data frame.
glatos_receivers <- function(x) {
......
......@@ -15,13 +15,8 @@
#' }
#'
#' @note
#' This function may be expanded in the future to dictate conversion
#' between various data sources (glatos, otn, other) and versions to
#' a single 'glatos_workbook' standard format. One way to do this might
#' be to (1) specify name_in, name_out, and type_in, type_out eg in the
#' schema data files, (2) use "..." argument to this constructor function to
#' allow each standard column to be mapped directly from source, and (3)
#' check that requirements are met.
#' This function may be developed in the future to dictate conversion
#' constuction from a data frame.
#'
#' @keywords internal
......
......@@ -18,11 +18,6 @@ Constructor function for the class glatos_animals. Currently barebones
and only used inside read_glatos_workbook.
}
\note{
This function may be expanded in the future to dictate conversion
between various data sources (glatos, otn, other) and versions to
a single 'glatos_animals' standard format. One way to do this might
be to (1) specify name_in, name_out, and type_in, type_out eg in the
schema data files, (2) use "..." argument to this constructor function to
allow each standard column to be mapped directly from source, and (3)
check that requirements are met.
This function may be developed in the future to dictate conversion
constuction from a data frame.
}
......@@ -15,14 +15,9 @@ A data.frame of class \code{glatos_detections}:
}
\description{
Constructor function for the class glatos_detections. Currently barebones
and only used inside read_glatos_detections.
and only used inside read_glatos_detections and read_otn_detections.
}
\note{
This function may be expanded in the future to dictate conversion
between various data sources (glatos, otn, other) and versions to
a single 'glatos_detection' standard format. One way to do this might
be to (1) specify name_in, name_out, and type_in, type_out eg in the
schema data files, (2) use "..." argument to this constructor function to
allow each standard column to be mapped directly from source, and (3)
check that requirements are met.
This function may be developed in the future to dictate conversion
constuction from a data frame.
}
......@@ -18,11 +18,6 @@ Constructor function for the class glatos_receivers.
Currently barebones and only used inside read_glatos_receivers.
}
\note{
This function may be expanded in the future to dictate conversion
between various data sources (glatos, otn, other) and versions to
a single 'glatos_detection' standard format. One way to do this might
be to (1) specify name_in, name_out, and type_in, type_out eg in the
schema data files, (2) use "..." argument to this constructor function to
allow each standard column to be mapped directly from source, and (3)
check that requirements are met.
This function may be developed in the future to dictate conversion
constuction from a data frame.
}
......@@ -24,12 +24,7 @@ Constructor function for the class glatos_workbook.
Currently barebones and only used inside read_glatos_workbook.
}
\note{
This function may be expanded in the future to dictate conversion
between various data sources (glatos, otn, other) and versions to
a single 'glatos_workbook' standard format. One way to do this might
be to (1) specify name_in, name_out, and type_in, type_out eg in the
schema data files, (2) use "..." argument to this constructor function to
allow each standard column to be mapped directly from source, and (3)
check that requirements are met.
This function may be developed in the future to dictate conversion
constuction from a data frame.
}
\keyword{internal}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment