Skip to content

Commit

Permalink
fix #359 remove old defunct function man file entries, keep around ge…
Browse files Browse the repository at this point in the history 
…fs in case gefs comes back
  • Loading branch information
@sckott
sckott committed Jun 12, 2020
1 parent 4eaf6ef commit 8fd8b3a
Show file tree
Hide file tree
Showing 28 changed files with 269 additions and 602 deletions.
24 changes: 0 additions & 24 deletions NAMESPACE
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,6 @@ export(buoys)
export(coops_search)
export(cpc_cache)
export(cpc_prcp)
export(erddap_clear_cache)
export(erddap_data)
export(erddap_datasets)
export(erddap_grid)
export(erddap_info)
export(erddap_search)
export(erddap_table)
export(ersst)
export(ersst_cache)
export(gefs)
Expand All @@ -40,7 +33,6 @@ export(gefs_times)
export(gefs_variables)
export(ghcnd)
export(ghcnd_cache)
export(ghcnd_clear_cache)
export(ghcnd_countries)
export(ghcnd_read)
export(ghcnd_search)
Expand All @@ -64,7 +56,6 @@ export(isd_stations)
export(isd_stations_search)
export(lcd)
export(lcd_cache)
export(lcd_cleanup)
export(meteo_clear_cache)
export(meteo_coverage)
export(meteo_distance)
Expand All @@ -79,32 +70,17 @@ export(ncdc_combine)
export(ncdc_datacats)
export(ncdc_datasets)
export(ncdc_datatypes)
export(ncdc_leg_data)
export(ncdc_leg_site_info)
export(ncdc_leg_sites)
export(ncdc_leg_variables)
export(ncdc_locs)
export(ncdc_locs_cats)
export(ncdc_plot)
export(ncdc_stations)
export(ncdc_theme)
export(noaa)
export(noaa_combine)
export(noaa_datacats)
export(noaa_datasets)
export(noaa_datatypes)
export(noaa_locs)
export(noaa_locs_cats)
export(noaa_plot)
export(noaa_seaice)
export(noaa_stations)
export(readshpfile)
export(rnoaa_options)
export(se_data)
export(se_files)
export(sea_ice)
export(sea_ice_tabular)
export(seaice)
export(seaiceeurls)
export(storm_data)
export(storm_meta)
Expand Down
285 changes: 40 additions & 245 deletions R/defunct.R
View file
Original file line number Diff line number Diff line change
@@ -1,188 +1,3 @@
#' This function is defunct.
#' @export
#' @rdname noaa-defunct
#' @keywords internal
noaa <- function(...){
.Defunct(new = "ncdc", package = "rnoaa", msg = "the noaa() function name has been changed to ncdc()")
}

#' This function is defunct.
#' @export
#' @rdname noaa_datacats-defunct
#' @keywords internal
noaa_datacats <- function(...){
.Defunct(new = "ncdc_datacats", package = "rnoaa", msg = "the noaa_datacats() function name has been changed to ncdc_datacats()")
}

#' This function is defunct.
#' @export
#' @rdname noaa_datasets-defunct
#' @keywords internal
noaa_datasets <- function(...){
.Defunct(new = "ncdc_datasets", package = "rnoaa", msg = "the noaa_datasets() function name has been changed to ncdc_datasets()")
}

#' This function is defunct.
#' @export
#' @rdname noaa_datatypes-defunct
#' @keywords internal
noaa_datatypes <- function(...){
.Defunct(new = "ncdc_datatypes", package = "rnoaa", msg = "the noaa_datatypes() function name has been changed to ncdc_datatypes()")
}

#' This function is defunct.
#' @export
#' @rdname noaa_locs-defunct
#' @keywords internal
noaa_locs <- function(...){
.Defunct(new = "ncdc_locs", package = "rnoaa", msg = "the noaa_locs() function name has been changed to ncdc_locs()")
}

#' This function is defunct.
#' @export
#' @rdname noaa_locs_cats-defunct
#' @keywords internal
noaa_locs_cats <- function(...){
.Defunct(new = "ncdc_locs_cats", package = "rnoaa", msg = "the noaa_locs_cats() function name has been changed to ncdc_locs_cats()")
}

#' This function is defunct.
#' @export
#' @rdname noaa_stations-defunct
#' @keywords internal
noaa_stations <- function(...){
.Defunct(new = "ncdc_stations", package = "rnoaa", msg = "the noaa_stations() function name has been changed to ncdc_stations()")
}

#' This function is defunct.
#' @export
#' @rdname noaa_plot-defunct
#' @keywords internal
noaa_plot <- function(...){
.Defunct(new = "ncdc_plot", package = "rnoaa", msg = "the noaa_plot() function name has been changed to ncdc_plot()")
}

#' This function is defunct.
#' @export
#' @rdname noaa_combine-defunct
#' @keywords internal
noaa_combine <- function(...){
.Defunct(new = "ncdc_combine", package = "rnoaa", msg = "the noaa_combine() function name has been changed to ncdc_combine()")
}

#' This function is defunct.
#' @export
#' @rdname noaa_seaice-defunct
#' @keywords internal
noaa_seaice <- function(...){
.Defunct(new = "seaice", package = "rnoaa", msg = "the noaa_seaice() function name has been changed to seaice()")
}

#' This function is defunct.
#' @export
#' @rdname erddap_data-defunct
#' @keywords internal
erddap_data <- function(){
.Defunct(msg = "See functions erddap_grid and erddap_table for griddap and tabledap data, respectively")
}

#' This function is defunct.
#' @export
#' @rdname erddap_clear_cache-defunct
#' @keywords internal
erddap_clear_cache <- function(){
.Defunct(msg = "See package rerddap")
}

#' This function is defunct.
#' @export
#' @rdname erddap_datasets-defunct
#' @keywords internal
erddap_datasets <- function(){
.Defunct(new = "ed_datasets", msg = "See ed_datasets() in package rerddap")
}

#' This function is defunct.
#' @export
#' @rdname erddap_grid-defunct
#' @keywords internal
erddap_grid <- function(){
.Defunct(new = "griddap", msg = "See griddap() in package rerddap")
}

#' This function is defunct.
#' @export
#' @rdname erddap_info-defunct
#' @keywords internal
erddap_info <- function(){
.Defunct(new = "info", msg = "See info() in package rerddap")
}

#' This function is defunct.
#' @export
#' @rdname erddap_search-defunct
#' @keywords internal
erddap_search <- function(){
.Defunct(new = "ed_search", msg = "See ed_search() in package rerddap")
}

#' This function is defunct.
#' @export
#' @rdname erddap_table-defunct
#' @keywords internal
erddap_table <- function(){
.Defunct(new = "tabledap", msg = "See tabledap() in package rerddap")
}


#' This function is defunct.
#' @export
#' @rdname ncdc_leg_variables-defunct
#' @keywords internal
ncdc_leg_variables <- function(){
.Defunct(msg = "This function is defunct, see ncdc_*() functions")
}

#' This function is defunct.
#' @export
#' @rdname ncdc_leg_sites-defunct
#' @keywords internal
ncdc_leg_sites <- function() {
.Defunct(msg = "This function is defunct, see ncdc_*() functions")
}

#' This function is defunct.
#' @export
#' @rdname ncdc_leg_site_info-defunct
#' @keywords internal
ncdc_leg_site_info <- function() {
.Defunct(msg = "This function is defunct, see ncdc_*() functions")
}

#' This function is defunct.
#' @export
#' @rdname ncdc_leg_data-defunct
#' @keywords internal
ncdc_leg_data <- function() {
.Defunct(msg = "This function is defunct, see ncdc_*() functions")
}

#' This function is defunct.
#' @export
#' @rdname seaice-defunct
#' @keywords internal
seaice <- function() {
.Defunct(msg = "This function is defunct, see sea_ice()")
}

#' This function is defunct.
#' @export
#' @rdname lcd_cleanup-defunct
#' @keywords internal
lcd_cleanup <- function(...) {
.Defunct(msg = "`lcd_cleanup` no longer available, see ?lcd")
}

#' This function is defunct.
#' @export
#' @rdname gefs-defunct
Expand Down Expand Up @@ -239,71 +54,51 @@ gefs_times <- function(...) {
gefs_variables <- function(...) {
.Defunct(msg = "`gefs_variables` is defunct; it may return later")
}
#' This function is defunct.
#' @export
#' @rdname ghcnd_clear_cache-defunct
#' @keywords internal
ghcnd_clear_cache <- function(...) {
.Defunct(msg = "`ghcnd_clear_cache` is defunct; see ?rnoaa_caching")
}


#' Defunct functions in rnoaa
#'
#' \itemize{
#' \item \code{\link{noaa}}: Function name changed, prefixed with ncdc now
#' \item \code{\link{noaa_datacats}}: Function name changed, prefixed with ncdc now
#' \item \code{\link{noaa_datasets}}: Function name changed, prefixed with ncdc now
#' \item \code{\link{noaa_datatypes}}: Function name changed, prefixed with ncdc now
#' \item \code{\link{noaa_locs}}: Function name changed, prefixed with ncdc now
#' \item \code{\link{noaa_locs_cats}}: Function name changed, prefixed with ncdc now
#' \item \code{\link{noaa_stations}}: Function name changed, prefixed with ncdc now
#' \item \code{\link{noaa_plot}}: Function name changed, prefixed with ncdc now
#' \item \code{\link{noaa_combine}}: Function name changed, prefixed with ncdc now
#' \item \code{\link{noaa_seaice}}: Function name changed to seaice
#' \item \code{\link{erddap_data}}: See package rerddap
#' \item \code{\link{erddap_clear_cache}}: See package rerddap
#' \item \code{\link{erddap_datasets}}: Moved to \code{ed_datasets} in
#' package rerddap
#' \item \code{\link{erddap_grid}}: Moved to \code{griddap} in package
#' rerddap
#' \item \code{\link{erddap_info}}: Moved to \code{info} in package
#' rerddap
#' \item \code{\link{erddap_search}}: Moved to \code{ed_search} in
#' package rerddap
#' \item \code{\link{erddap_table}}: Moved to \code{tabledap} in
#' package rerddap
#' \item \code{\link{ncdc_leg_variables}}: Removed. See \code{NCDC Legacy} below
#' \item \code{\link{ncdc_leg_sites}}: Removed. See \code{NCDC Legacy} below
#' \item \code{\link{ncdc_leg_site_info}}: Removed. See \code{NCDC Legacy} below
#' \item \code{\link{ncdc_leg_data}}: Removed. See \code{NCDC Legacy} below
#' \item \code{\link{seaice}}: Replaced with \code{\link{sea_ice}}
#' \item \code{\link{lcd_cleanup}}: No longer available. See \code{\link{lcd}}
#' docs
#' \item \code{\link{ghcnd_clear_cache}}: No longer available.
#' See \code{\link{rnoaa_caching}}
#' }
#'
#' - `noaa`: Function name changed, prefixed with ncdc now
#' - `noaa_datacats`: Function name changed, prefixed with ncdc now
#' - `noaa_datasets`: Function name changed, prefixed with ncdc now
#' - `noaa_datatypes`: Function name changed, prefixed with ncdc now
#' - `noaa_locs`: Function name changed, prefixed with ncdc now
#' - `noaa_locs_cats`: Function name changed, prefixed with ncdc now
#' - `noaa_stations`: Function name changed, prefixed with ncdc now
#' - `noaa_plot`: Function name changed, prefixed with ncdc now
#' - `noaa_combine`: Function name changed, prefixed with ncdc now
#' - `noaa_seaice`: Function name changed to seaice
#' - `erddap_data`: See package rerddap
#' - `erddap_clear_cache`: See package rerddap
#' - `erddap_datasets`: Moved to package rerddap
#' - `erddap_grid`: Moved to package rerddap
#' - `erddap_info`: Moved to `rerddap::info()`
#' - `erddap_search`: Moved to `rerddap::ed_search`
#' - `erddap_table`: Moved to `rerddap::tabledap`
#' - `ncdc_leg_variables`: Removed. See `NCDC Legacy` below
#' - `ncdc_leg_sites`: Removed. See `NCDC Legacy` below
#' - `ncdc_leg_site_info`: Removed. See `NCDC Legacy` below
#' - `ncdc_leg_data`: Removed. See `NCDC Legacy` below
#' - `seaice`: Replaced with [sea_ice()]
#' - `lcd_cleanup`: No longer available. See `lcd` docs
#' - `ghcnd_clear_cache`: No longer available. See [rnoaa_caching]
#'
#' The functions for working with GEFS ensemble forecast data (prefixed with
#' "gefs") are defunct, but may come back to rnoaa later. They are:
#'
#' \itemize{
#' \item \code{\link{gefs}}
#' \item \code{\link{gefs_dimension_values}}
#' \item \code{\link{gefs_dimensions}}
#' \item \code{\link{gefs_ensembles}}
#' \item \code{\link{gefs_latitudes}}
#' \item \code{\link{gefs_longitudes}}
#' \item \code{\link{gefs_times}}
#' \item \code{\link{gefs_variables}}
#' }
#'
#'
#' "gefs") are defunct, but may come back to rnoaa later:
#'
#' - [gefs()]
#' - [gefs_dimension_values()]
#' - [gefs_dimensions()]
#' - [gefs_ensembles()]
#' - [gefs_latitudes()]
#' - [gefs_longitudes()]
#' - [gefs_times()]
#' - [gefs_variables()]
#'
#' @section NCDC Legacy:
#' The NCDC legacy API is too unreliable and slow. Use the newer NCDC API via the
#' functions \code{\link{ncdc}}, \code{\link{ncdc_datacats}}, \code{\link{ncdc_datasets}},
#' \code{\link{ncdc_datatypes}}, \code{\link{ncdc_locs}}, \code{\link{ncdc_locs_cats}},
#' \code{\link{ncdc_stations}}, \code{\link{ncdc_plot}}, and \code{\link{ncdc_combine}}
#' The NCDC legacy API is too unreliable and slow. Use the newer NCDC API via
#' the functions [ncdc()], [ncdc_datacats()], [ncdc_datasets()],
#' [ncdc_datatypes()], [ncdc_locs()], [ncdc_locs_cats()], [ncdc_stations()],
#' [ncdc_plot()], and [ncdc_combine()]
#'
#' @name rnoaa-defunct
NULL
Loading

0 comments on commit 8fd8b3a

Please sign in to comment.