R/parseFilenames.R

In jbrzusto/sensorgnome-R-package: Tools for the sensorgnome project.

#' parse sensorgnome filenames into components
#' 
#' @param f: character vector of filenames with full path
#'
#' @return a dataframe of components, with one row per filename and these columns:
#'
#' \enumerate{
#'  \item "prefix":  human readable short site name
#'  \item "recv":  receiver ID; 12 alphanumeric character serial number
#'  \item "macAddr": 12 byte hex mac address (lower case); NA if not available
#'  \item "bootnum":  boot count (integer)
#'  \item "ts":  timestamp embedded in name (double, with class \code{c("POSIXt", "POSIXct")} )
#'  \item "tsCode":  timestamp code ('P' means before GPS fix, 'Z' means accurate to 1e-6 s, 'Y' to 1e-5s, 'X' to 1e-4s, ..., 'T' to 1s)
#'  \item "port":  port number, if this file is associated with a single port (e.g. a .WAV file); NA if all ports
#'  \item "extension":  extension of uncompressed file; e.g. ".txt"
#'  \item "comp":  integer; file compression type":  NA = uncompressed, 1 = gzip, 2 = lzip
#'
#' }
#' 

parseFilenames = function(f) {
    rv = splitToDF(sgFilenameRegex, f, as.is=TRUE)
    class(rv$ts) = c("POSIXt", "POSIXct")
    return(rv)
}