Skip to content

Commit

Permalink
CRAN Version 1.0.2
Browse files Browse the repository at this point in the history
Fixes issue with package-level documentation
  • Loading branch information
rmendels committed Aug 22, 2023
1 parent eaf5869 commit 3d8f899
Show file tree
Hide file tree
Showing 7 changed files with 122 additions and 48 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: plotdap
Title: Easily Visualize Data from 'ERDDAP' Servers via the 'rerddap' Package
Version: 1.0.1
Date: 2022-12-21
Version: 1.0.2
Date: 2023-08-21
Authors@R: c(
person("Carson", "Sievert", role = "aut"),
person("Roy", "Mendelssohn", role = c("aut", "ctb", "cre"), email = "[email protected]"))
Expand Down
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# plotdap 1.0.2

fixed problem with package level documentation not working properly

# plotdap 1.0.1

Correctly removed dependency on rgeos, rgdal
Expand Down
33 changes: 15 additions & 18 deletions R/add_griddap.R
Original file line number Diff line number Diff line change
Expand Up @@ -34,29 +34,26 @@
#'
#' # actual datasets in data folder to meet execution timings
#'
#'\donttest{
#' murSST <- rerddap::griddap(
#' 'jplMURSST41', latitude = c(35, 40), longitude = c(-125, -120.5),
#' time = c('last', 'last'), fields = 'analysed_sst'
#' )
#'
#' QMwind <- rerddap::griddap(
#' 'erdQMwindmday', time = c('2016-11-16', '2017-01-16'),
#' latitude = c(30, 50), longitude = c(210, 240),
#' fields = 'x_wind'
#' )
#' # murSST <- rerddap::griddap(
#' # ' jplMURSST41', latitude = c(35, 40), longitude = c(-125, -120.5),
#' # time = c('last', 'last'), fields = 'analysed_sst'
#' # )
#'
#' p <- plotdap(crs = "+proj=robin")
#' add_griddap(p, murSST, ~analysed_sst)
#' # QMwind <- rerddap::griddap(
#' # 'erdQMwindmday', time = c('2016-11-16', '2017-01-16'),
#' # latitude = c(30, 50), longitude = c(210, 240),
#' # fields = 'x_wind'
#' # )
#'
#' p <- plotdap(mapTitle = "Average wind over time")
#' add_griddap(p, QMwind, ~x_wind)
#' p <- plotdap(crs = "+proj=robin")
#' p <- add_griddap(p, murSST, ~analysed_sst)
#'
#'}
#' # p <- plotdap(mapTitle = "Average wind over time")
#' # p <- add_griddap(p, QMwind, ~x_wind)
#'
#
#' p <- plotdap("base", crs = "+proj=robin")
#' p <- add_griddap(p, murSST, ~analysed_sst)
#' # p <- plotdap("base", crs = "+proj=robin")
#' # p <- add_griddap(p, murSST, ~analysed_sst)
#'
#' # layer tables on top of grids
#' require(magrittr)
Expand Down
31 changes: 31 additions & 0 deletions R/plotdap-package.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#' plotdap: Easily Visualize Data from 'ERDDAP' Servers via the 'rerddap' Package
#'
#'
#' Easily visualize and animate 'tabledap' and 'griddap' objects obtained via the
#' 'rerddap' package in a simple one-line command, using either base graphics or
#' 'ggplot2' graphics. 'plotdap' handles extracting and reshaping the data, map
#' projections and continental outlines. Optionally the data can be animated
#' through time using the 'gganmiate' package.#'
#'
#' The package contains four main functions:
#'
#' @section Main Functions:
#' \itemize{
#' \item \code{plotdap} - Visualize data returned from rerddap servers.
#' \item \code{add_griddap} - Add rerddap::griddap() data to a plotdap map
#' \item \code{add_tabledap} - Add rerddap::tabledap data to a plotdap map
#' \item \code{add_ggplot} - Add ggplot2 elements to a plotdap object
#' }
#'#'
#' @section Details:
#' Besides the terse help documents, more detail in using the
#' functions are given in the included vignette "using_plotdap". The datasets used
#' in the vignette are included in the "data" directory.

#' @keywords internal
#'@aliases plotdap-package
"_PACKAGE"

## usethis namespace: start
## usethis namespace: end
NULL
14 changes: 4 additions & 10 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
## Various minor fixes

Correctly removed dependency on rgeos, rgdal



## Minor fix

fixes problem with package level documentation

## Test environments
* local OS X install, R 4.2.2
* local OS X install, R 4.3.1
* rhub
* macOS-builder
* win-builder (devel and release)
Expand All @@ -16,9 +12,7 @@ Correctly removed dependency on rgeos, rgdal

### OS X

Duration: 4m 23.5s

0 errors ✓ | 0 warnings ✓ | 0 notes ✓
OK

### Winbuilder release

Expand Down
34 changes: 16 additions & 18 deletions man/add_griddap.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

50 changes: 50 additions & 0 deletions man/plotdap-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3d8f899

Please sign in to comment.