Commit ee96f1c2 authored by jml's avatar jml
Browse files

update vignettes and update doc

parent 4fde8ad5
# Generated by roxygen2: do not edit by hand
export(friendlyr)
export(meta)
export(qa)
export(ts)
# Generated by roxygen2: do not edit by hand
export(friendlyr)
export(meta)
export(qa)
export(ts)
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/friendlyr.R
\name{friendlyr}
\alias{friendlyr}
\title{friendlyr
friendlyr}
\usage{
friendlyr(service, username = NULL, password = NULL)
}
\arguments{
\item{service}{name of the session}
\item{username}{username}
\item{password}{password}
}
\description{
friendlyr
friendlyr
}
\examples{
\dontrun{
friendlyr()
}
}
\keyword{friendlyr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/friendlyr.R
\name{friendlyr}
\alias{friendlyr}
\title{friendlyr
friendlyr}
\usage{
friendlyr(service, username = NULL, password = NULL)
}
\arguments{
\item{service}{name of the session}
\item{username}{username}
\item{password}{password}
}
\description{
friendlyr
friendlyr
}
\examples{
\dontrun{
friendlyr()
}
}
\keyword{friendlyr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/meta.R
\name{meta}
\alias{meta}
\title{meta
meta}
\usage{
meta(service, username = NULL, password = NULL, element_id = NULL,
timeResolution = NULL, station_id = NULL, location = NULL)
}
\arguments{
\item{service}{service}
\item{username}{username}
\item{password}{password}
\item{element_id}{element ids "NO2" "O3", c(...),...}
\item{timeResolution}{timeResolution time resolution second, minute, houly, daily, monthly, yearly}
\item{station_id}{station ids "665", c(...),...}
\item{location}{location}
}
\description{
meta
meta
}
\examples{
\dontrun{
meta()
}
}
\keyword{friendlyr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/meta.R
\name{meta}
\alias{meta}
\title{meta
meta}
\usage{
meta(service, username = NULL, password = NULL, element_id = NULL,
timeResolution = NULL, station_id = NULL, location = NULL)
}
\arguments{
\item{service}{service}
\item{username}{username}
\item{password}{password}
\item{element_id}{element ids "NO2" "O3", c(...),...}
\item{timeResolution}{timeResolution time resolution second, minute, houly, daily, monthly, yearly}
\item{station_id}{station ids "665", c(...),...}
\item{location}{location}
}
\description{
meta
meta
}
\examples{
\dontrun{
meta()
}
}
\keyword{friendlyr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/qa.R
\name{qa}
\alias{qa}
\title{qa
qa}
\usage{
qa(service = NULL, username = NULL, password = NULL,
fromDate = NULL, toDate = NULL, precision = NULL,
timeResolution = NULL, element_id = NULL, station_id = NULL,
location = NULL)
}
\arguments{
\item{service}{service}
\item{username}{username}
\item{password}{password}
\item{fromDate}{fromDate from "2016/11/01 00:00:00"}
\item{toDate}{toDate to "2017/05/01 00:00:00"}
\item{precision}{precision second, minute, houly, daily, monthly, yearly}
\item{timeResolution}{timeResolution time resolution second, minute, houly, daily, monthly, yearly}
\item{element_id}{element ids "NO2" "O3", c(...),...}
\item{station_id}{station ids "665", c(...),...}
\item{location}{location}
}
\description{
qa
qa
}
\examples{
\dontrun{
qa()
}
}
\keyword{friendlyr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/qa.R
\name{qa}
\alias{qa}
\title{qa
qa}
\usage{
qa(service = NULL, username = NULL, password = NULL,
fromDate = NULL, toDate = NULL, precision = NULL,
timeResolution = NULL, element_id = NULL, station_id = NULL,
location = NULL)
}
\arguments{
\item{service}{service}
\item{username}{username}
\item{password}{password}
\item{fromDate}{fromDate from "2016/11/01 00:00:00"}
\item{toDate}{toDate to "2017/05/01 00:00:00"}
\item{precision}{precision second, minute, houly, daily, monthly, yearly}
\item{timeResolution}{timeResolution time resolution second, minute, houly, daily, monthly, yearly}
\item{element_id}{element ids "NO2" "O3", c(...),...}
\item{station_id}{station ids "665", c(...),...}
\item{location}{location}
}
\description{
qa
qa
}
\examples{
\dontrun{
qa()
}
}
\keyword{friendlyr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ts.R
\name{ts}
\alias{ts}
\title{ts
ts}
\usage{
ts(service = NULL, username = NULL, password = NULL,
fromDate = NULL, toDate = NULL, precision = NULL,
timeResolution = NULL, element_id = NULL, station_id = NULL,
location = NULL)
}
\arguments{
\item{service}{service}
\item{username}{username}
\item{password}{password}
\item{fromDate}{fromDate from "2016/11/01 00:00:00"}
\item{toDate}{toDate to "2017/05/01 00:00:00"}
\item{precision}{precision second, minute, houly, daily, monthly, yearly}
\item{timeResolution}{timeResolution time resolution second, minute, houly, daily, monthly, yearly}
\item{element_id}{element ids "NO2" "O3", c(...),...}
\item{station_id}{station ids "665", c(...),...}
\item{location}{location}
}
\description{
ts
ts
}
\examples{
\dontrun{
ts()
}
}
\keyword{friendlyr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ts.R
\name{ts}
\alias{ts}
\title{ts
ts}
\usage{
ts(service = NULL, username = NULL, password = NULL,
fromDate = NULL, toDate = NULL, precision = NULL,
timeResolution = NULL, element_id = NULL, station_id = NULL,
location = NULL)
}
\arguments{
\item{service}{service}
\item{username}{username}
\item{password}{password}
\item{fromDate}{fromDate from "2016/11/01 00:00:00"}
\item{toDate}{toDate to "2017/05/01 00:00:00"}
\item{precision}{precision second, minute, houly, daily, monthly, yearly}
\item{timeResolution}{timeResolution time resolution second, minute, houly, daily, monthly, yearly}
\item{element_id}{element ids "NO2" "O3", c(...),...}
\item{station_id}{station ids "665", c(...),...}
\item{location}{location}
}
\description{
ts
ts
}
\examples{
\dontrun{
ts()
}
}
\keyword{friendlyr}
---
title: "eimet"
title: "data.eimet"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{eimet}
%\VignetteIndexEntry{data.eimet}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
......@@ -26,7 +26,7 @@ element_id=c("rain","temp")
location <- NULL
df <- friendlyr::ts(service="eimetlyr",
df <- friendlyr::ts(service="d.eimetlyr",
fromDate=fromDate,toDate=toDate,precision=timeResolution,timeResolution=timeResolution,
element_id=element_id,station_id=station_id)
......@@ -35,14 +35,14 @@ df <- friendlyr::ts(service="eimetlyr",
## Get metadata
```R
metadata <- friendlyr::meta(service="eimetlyr",element_id=element_id,station_id=station_id)
metadata <- friendlyr::meta(service="d.eimetlyr",element_id=element_id,station_id=station_id)
```
## Get Quality flags
```R
df <- friendlyr::qa(service="eimetlyr",
df <- friendlyr::qa(service="d.eimetlyr",
fromDate=fromDate,toDate=toDate,precision=timeResolution,timeResolution=timeResolution,
element_id=element_id,station_id=station_id)
......
---
title: "data.eipa"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{data.eipa}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
```{r setup, include = FALSE}
library(friendlyr)
knitr::opts_chunk$set(collapse = T, comment = "#>")
```
## Get timeseries data
Get data from EPA Ireland embedded dataset.
```R
fromDate="2008/03/01 02:00:00"
toDate="2008/03/01 09:00:00"
timeResolution="hourly"
station_id=c("D1","D12","D14")
element_id=c("NO2","O3")
location <- NULL
df <- friendlyr::ts(service="d.eipalyr",
fromDate=fromDate,toDate=toDate,precision=timeResolution,timeResolution=timeResolution,
element_id=element_id,station_id=station_id)
```
## Get metadata
```R
metadata <- friendlyr::meta(service="d.eipalyr",element_id=element_id,station_id=station_id)
```
Markdown is supported
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