Commit 4e5c2515 authored by Laura A DeCicco's avatar Laura A DeCicco
Browse files

Better wording for NGWMN

parent fd26e5eb
...@@ -5,9 +5,12 @@ ...@@ -5,9 +5,12 @@
#' #'
#' @param input character or raw, containing the url for the retrieval or a path to the data file, or raw XML. #' @param input character or raw, containing the url for the retrieval or a path to the data file, or raw XML.
#' @param asDateTime logical, if \code{TRUE} returns date and time as POSIXct, if \code{FALSE}, character #' @param asDateTime logical, if \code{TRUE} returns date and time as POSIXct, if \code{FALSE}, character
#' @param tz character to set timezone attribute of datetime. Default is UTC (properly accounting for daylight savings times based on the data's provided time zone offset). #' @param tz character to set timezone attribute of dateTime. Default is "UTC", and converts the
#' Possible values include "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles", #' date times to UTC, properly accounting for daylight savings times based on the data's provided time zone offset.
#' "America/Anchorage","America/Honolulu","America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla" #' Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles",
#' "America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu",
#' "America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()}
#' for more information on time zones.
#' @return mergedDF a data frame source, time, value, uom, uomTitle, comment, gmlID #' @return mergedDF a data frame source, time, value, uom, uomTitle, comment, gmlID
#' @export #' @export
#' @importFrom xml2 read_xml #' @importFrom xml2 read_xml
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
#' @param asDateTime logical if \code{TRUE}, will convert times to POSIXct format. Currently defaults to #' @param asDateTime logical if \code{TRUE}, will convert times to POSIXct format. Currently defaults to
#' \code{FALSE} since time zone information is not included. #' \code{FALSE} since time zone information is not included.
#' @param tz character to set timezone attribute of dateTime. Default is "UTC", and converts the #' @param tz character to set timezone attribute of dateTime. Default is "UTC", and converts the
#' date times to UTC, properly accounting for daylight savings times based on the data's provided tz_cd column. #' date times to UTC, properly accounting for daylight savings times based on the data's provided time zone offset.
#' Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles", #' Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles",
#' "America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu", #' "America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu",
#' "America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()} #' "America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()}
...@@ -98,7 +98,7 @@ readNGWMNdata <- function(service, ..., asDateTime = TRUE, tz = "UTC"){ ...@@ -98,7 +98,7 @@ readNGWMNdata <- function(service, ..., asDateTime = TRUE, tz = "UTC"){
#' or returned as character? Defaults to \code{TRUE}. Must be set to \code{FALSE} if a site #' or returned as character? Defaults to \code{TRUE}. Must be set to \code{FALSE} if a site
#' contains non-standard dates. #' contains non-standard dates.
#' @param tz character to set timezone attribute of dateTime. Default is "UTC", and converts the #' @param tz character to set timezone attribute of dateTime. Default is "UTC", and converts the
#' date times to UTC, properly accounting for daylight savings times based on the data's provided tz_cd column. #' date times to UTC, properly accounting for daylight savings times based on the data's provided time zone offset.
#' Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles", #' Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles",
#' "America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu", #' "America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu",
#' "America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()} #' "America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()}
......
...@@ -11,9 +11,12 @@ importNGWMN(input, asDateTime = FALSE, tz = "UTC") ...@@ -11,9 +11,12 @@ importNGWMN(input, asDateTime = FALSE, tz = "UTC")
\item{asDateTime}{logical, if \code{TRUE} returns date and time as POSIXct, if \code{FALSE}, character} \item{asDateTime}{logical, if \code{TRUE} returns date and time as POSIXct, if \code{FALSE}, character}
\item{tz}{character to set timezone attribute of datetime. Default is UTC (properly accounting for daylight savings times based on the data's provided time zone offset). \item{tz}{character to set timezone attribute of dateTime. Default is "UTC", and converts the
Possible values include "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles", date times to UTC, properly accounting for daylight savings times based on the data's provided time zone offset.
"America/Anchorage","America/Honolulu","America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla"} Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles",
"America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu",
"America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()}
for more information on time zones.}
} }
\value{ \value{
mergedDF a data frame source, time, value, uom, uomTitle, comment, gmlID mergedDF a data frame source, time, value, uom, uomTitle, comment, gmlID
......
...@@ -15,7 +15,7 @@ readNGWMNdata(service, ..., asDateTime = TRUE, tz = "UTC") ...@@ -15,7 +15,7 @@ readNGWMNdata(service, ..., asDateTime = TRUE, tz = "UTC")
\code{FALSE} since time zone information is not included.} \code{FALSE} since time zone information is not included.}
\item{tz}{character to set timezone attribute of dateTime. Default is "UTC", and converts the \item{tz}{character to set timezone attribute of dateTime. Default is "UTC", and converts the
date times to UTC, properly accounting for daylight savings times based on the data's provided tz_cd column. date times to UTC, properly accounting for daylight savings times based on the data's provided time zone offset.
Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles", Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles",
"America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu", "America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu",
"America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()} "America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()}
......
...@@ -15,7 +15,7 @@ or returned as character? Defaults to \code{TRUE}. Must be set to \code{FALSE} ...@@ -15,7 +15,7 @@ or returned as character? Defaults to \code{TRUE}. Must be set to \code{FALSE}
contains non-standard dates.} contains non-standard dates.}
\item{tz}{character to set timezone attribute of dateTime. Default is "UTC", and converts the \item{tz}{character to set timezone attribute of dateTime. Default is "UTC", and converts the
date times to UTC, properly accounting for daylight savings times based on the data's provided tz_cd column. date times to UTC, properly accounting for daylight savings times based on the data's provided time zone offset.
Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles", Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles",
"America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu", "America/Anchorage", as well as the following which do not use daylight savings time: "America/Honolulu",
"America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()} "America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also \code{OlsonNames()}
......
Supports Markdown
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