Skip to content
Snippets Groups Projects
getDataFromFile.Rd 1.17 KiB
Newer Older
  • Learn to ignore specific revisions
  • % Generated by roxygen2 (4.0.2): do not edit by hand
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \name{getDataFromFile}
    \alias{getDataFromFile}
    \title{Basic Data Import for Water Flow Data}
    \usage{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    getDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",")
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \arguments{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \item{filePath}{string specifying the path to the file}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \item{fileName}{string name of file to open}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \item{hasHeader}{logical true if the first row of data is the column headers}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \item{separator}{string character that separates data cells}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \value{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    retval dataframe with dateTime, value, and code columns
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \description{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    Imports data from user-supplied data file. Specifically used to import water flow data for use in the WRTDS package.
    For WRTDS usage, the first column is expected to be dates, the second column measured values.
    The third column is optional, it contains any remark codes.
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \examples{
    # Examples of how to use getDataFromFile:
    # Change the file path and file name to something meaningful:
    
    filePath <- system.file("extdata", package="dataRetrieval")
    filePath <- paste(filePath,"/",sep="")
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    fileName <- 'ChoptankRiverFlow.txt'
    
    ChopData <- getDataFromFile(filePath,fileName, separator="\\t")
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \keyword{data}
    \keyword{file}
    \keyword{import}