R/europollution.R

In vincentbagilet/europollution: R wrapper to access air pollution data from the European Environment Agency

#' \code{europollution} package
#'
#' A R wrapper to access air pollution data from the European Environment Agency
#'
#' This package is R wrapper to access air pollution data from the European Environment Agency,
#' along with some potentially useful data wrangling functions.
#'
#' Air pollution data from the European Environment Agency comes in a specific format and it requires some coding to gather it in a nice data frame.
#' The following package provides this short coding and wrangles the data into a user-friendly `R` format.
#'
#' @section Functions:
#'
#' This package contains the functions:
#' \itemize{
#'   \item \code{ep_get_urls}: creates a vector of the URLs for the datasets
#'   \item \code{ep_metadata}: downloads sampling point metadata
#'   \item \code{ep_download}: downloads air pollution data for European cities
#'   \item \code{ep_search_pollutant}: provides the code for a pollutant based on its name
#' }
#'
#' @section Data source:
#'
#' \itemize{
#'   \item A detailed decription of the dataset can be found here: \url{https://www.eea.europa.eu/data-and-maps/data/aqereporting-8}
#'   \item Instructions on access to the data are provided here: \url{https://discomap.eea.europa.eu/map/fme/AirQualityExport.htm}
#'}
#'
#'On the EEA website, the process to access the data is as follows:
#'\enumerate{
#'  \item Write a simple request URL based on values of parameters.
#'  \item This request URL leads to a set of URLs enabling to download a large number of data files, separately.
#'  \item Download the files.
#'}
#'
#'The present package enables to simplify and somehow automatize the download process in \code{R}.
#'It also provides simple cleaning functions.
#'
#' @docType package
#' @name europollution
#'
NULL

## quiets concerns of R CMD check re: the .'s that appear in pipelines
if(getRversion() >= "2.15.1")  utils::globalVariables(c("."))