Skip to content
Snippets Groups Projects
getSampleDataFromFile.Rd 1.18 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{getSampleDataFromFile}
    \alias{getSampleDataFromFile}
    \title{Import Sample Data for WRTDS}
    \usage{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    getSampleDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",",
      interactive = TRUE)
    
    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
    
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \item{interactive}{logical Option for interactive mode.  If true, there is user interaction for error handling and data checks.}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \value{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    Sample dataframe
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \description{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    Imports data from a user-supplied file, and converts it to a Sample data frame (including summing multiple constituents), appropriate for WRTDS calculations. See
    section 3.4 of the vignette for more details.
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \examples{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    filePath <- system.file("extdata", package="dataRetrieval")
    filePath <- paste(filePath,"/",sep="")
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    fileName <- 'ChoptankRiverNitrate.csv'
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    Sample <- getSampleDataFromFile(filePath,fileName, separator=";",interactive=FALSE)
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    
    \keyword{USGS}
    \keyword{WRTDS}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \keyword{data}
    \keyword{file}
    \keyword{import}