R/rWind-package.R

In rWind: Download, Edit and Include Wind and Sea Currents Data in Ecological and Evolutionary Analysis

#' Download, edit and include wind and sea currents data in ecological and evolutionary analysis
#'
#' rWind contain tools for downloading, editing and transforming wind and sea currents data from
#' Global Forecast System (GFS) and Ocean Surface Current Analyses Real-time (OSCAR). It also allows to use wind and sea currents data to compute the
#' minimum cost path from wind speed and direction to perform
#' connectivity analysis.
#'
#' The complete list of functions can be displayed with \code{library(help =
#' rWind)}. For more information, please check:
#' http://allthiswasfield.blogspot.com.es/
#'
#' @name rWind-package
#' @aliases rWind-package rWind
#' @docType package
#' @author Javier Fernández-López
#'
#' Klaus Schliep
#'
#' Yurena Arjona
#'
#' Maintainer: Javier Fernández-López <jflopez.bio@@gmail.com>
#' @keywords package
NULL

#' Wind data example
#'
#' This is an example of wind data obtained with wind.dl function for the
#' Iberian Peninsula coordinates on 12/February/2015 at 00:00 (UTC)
#'
#'
#' This data set is the result of:
#'
#' \code{wind.data <- wind.dl(2015,2,12,0,-10,5,35,45)}
#'
#' @name wind.data
#' @docType data
#' @format A list with one data.frame with 651 observations on the following 7
#' variables:
#' \describe{ \item{list("time (UTC)")}{a numeric with selected time of wind
#' data } \item{list("latitude (degrees_north)")}{a numeric with latitude values
#' } \item{list("longitude (degrees_east)")}{a numeric with longitude values }
#' \item{list("ugrd10m (m s-1)")}{a numeric with U component of wind data }
#' \item{list("vgrd10m (m s-1)")}{a numeric with V component of wind data }
#' \item{list("dir")}{a numeric with direction of wind data }
#' \item{list("speed")}{a numeric with speed of wind data } }
#' @references
#' http://oos.soest.hawaii.edu/erddap/info/NCEP_Global_Best/index.html
#' @source
#'
#' http://allthiswasfield.blogspot.com.es/2016/12/rwind-r-package-released.html
#' @keywords datasets
#' @examples
#'
#' data(wind.data)
#' str(wind.data)
#' head(wind.data[[1]])
NULL


#' Wind series example
#'
#' This is an example of a wind series data obtained with wind.dl function
#' for New Zealand area on 3/January/2015 at all the available times:
#' 00:00 - 03:00 - 06:00 - 09:00 - 12:00 - 15:00 - 18:00 - 21:00 (UTC)
#'
#' This data set is the result of:
#'
#' \code{library(lubridate)}
#' \code{dt <- seq(ymd_h(paste(2015,1,3,00, sep="-")),}
#' \code{          ymd_h(paste(2015,1,3,21, sep="-")),by="3 hours")}
#' \code{wind.series <- wind.dl_2(dt, 164, 179, -48, -33)}
#'
#' @name wind.series
#' @docType data
#' @format The format is an rWind list of 8 data.frame. Each data.frame contain
#' 961 observations on the following 7 variables:
#'
#' \describe{ \item{list("time (UTC)")}{a factor with selected time of wind
#' data } \item{list("latitude (degrees_north)")}{a factor with latitude values
#' } \item{list("longitude (degrees_east)")}{a factor with longitude values }
#' \item{list("ugrd10m (m s-1)")}{a factor with U component of wind data }
#' \item{list("vgrd10m (m s-1)")}{a factor with V component of wind data }
#' \item{list("dir")}{a numeric with direction of wind data }
#' \item{list("speed")}{a numeric with speed of wind data } }
#'
#' @references
#' http://oos.soest.hawaii.edu/erddap/info/NCEP_Global_Best/index.html
#' @source
#' http://allthiswasfield.blogspot.com.es/2016/12/rwind-r-package-released.html
#' @keywords datasets
#' @examples
#'
#' data(wind.series)
#' str(tidy(wind.series))
NULL