style: rename available_versions() in get_available_versions()

NAMESPACE

@@ -1,6 +1,5 @@
 # Generated by roxygen2: do not edit by hand
 
-export(available_versions)
 export(compute_abundances)
 export(compute_concentration_bins_CPR_n)
 export(compute_concentrations)
@@ -14,6 +13,7 @@ export(filter_by_polygon)
 export(filter_by_species)
 export(filter_by_year)
 export(geom_basemap)
+export(get_available_versions)
 export(get_current_version)
 export(get_ocean_names)
 export(get_required_columns)

R/available_versions.R → R/get_available_versions.R

@@ -13,9 +13,9 @@
 #' @examples
 #' ## Versions of the FORCIS database ----
 #' 
-#' available_versions()
+#' get_available_versions()
 
-available_versions <- function(record_id = zen_record_id()) {
+get_available_versions <- function(record_id = zen_record_id()) {
 
   ## Check argument ----
 

R/get_version_info.R

@@ -4,8 +4,8 @@
 #'   in the Zenodo database.
 #'   
 #' @param version a `character` of length 1. The label of the version. Use 
-#'   [available_versions()] to list available versions. If `NULL` (default) the
-#'   latest version is used.
+#'   [get_available_versions()] to list available versions. If `NULL` (default)
+#'   the latest version is used.
 #'
 #' @return A `list` with all information about the version, including: `title`,
 #' `doi`, `publication_date`, `description`, `access_right`, `creators`, 
@@ -56,7 +56,7 @@ get_version_info <- function(record_id = zen_record_id(), version = NULL) {
     if (length(pos) == 0) {
 
       stop("The required version is not available. Please run ", 
-           "'available_versions()' to list available versions.")
+           "'get_available_versions()' to list available versions.")
     }
   }
 

R/internals.R

@@ -736,7 +736,7 @@ set_zen_version <- function(version, ask = TRUE) {
 
   check_zen_version(version)
 
-  versions       <- available_versions()
+  versions       <- get_available_versions()
   latest_version <- get_zen_latest_version()
 
   if (is.null(version)) {
@@ -753,7 +753,8 @@ set_zen_version <- function(version, ask = TRUE) {
     if (!(version %in% versions$"version")) {
 
       stop("The required version is not available. Please run ", 
-           "'available_versions()' to list available versions.", call. = FALSE)
+           "'get_available_versions()' to list available versions.", 
+           call. = FALSE)
     }
   }
 
@@ -792,7 +793,7 @@ set_zen_version <- function(version, ask = TRUE) {
 
 get_zen_latest_version <- function() {
 
-  versions <- available_versions()
+  versions <- get_available_versions()
 
   versions[which.max(as.Date(versions$"publication_date")), "version"]
 }