Skip to content
Snippets Groups Projects
getQWDataFromFile.Rd 1.25 KiB
Newer Older
% Generated by roxygen2 (4.0.2): do not edit by hand
Laura A DeCicco's avatar
Laura A DeCicco committed
\name{getQWDataFromFile}
\alias{getQWDataFromFile}
\title{Basic Data Import}
\usage{
Laura A DeCicco's avatar
Laura A DeCicco committed
getQWDataFromFile(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
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 quality data for use in the WRTDS package.
For WRTDS usage, the first column is expected to be dates, the second column remarks (specifically < if censored data),
and the third column is measured values.  There can be additional columns of data, for each column of data, there should
be a remark column preceeding.
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\examples{
# Examples of how to use getQWDataFromFile:
# Change the file path and file name to something meaningful:
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
rawSampleData <- getQWDataFromFile(filePath,fileName, separator=";")
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\keyword{data}
\keyword{file}
\keyword{import}