R/view_datasets_MexicoDataAPI.R

In MexicoDataAPI: Access Mexican Data via APIs and Curated Datasets

# MexicoDataAPI - Access Mexican Data via APIs and Curated Datasets
# Version 0.1.0
# Copyright (C) 2025 Renzo Caceres Rossi
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.


#' View Available Datasets in MexicoDataAPI
#'
#' This function lists all datasets available in the 'MexicoDataAPI' package.
#' If the 'MexicoDataAPI' package is not loaded, it stops and shows an error message.
#' If no datasets are available, it returns a message and an empty vector.
#'
#' @return A character vector with the names of the available datasets.
#'         If no datasets are found, it returns an empty character vector.
#' @examples
#' if (requireNamespace("MexicoDataAPI", quietly = TRUE)) {
#'   library(MexicoDataAPI)
#'   view_datasets_MexicoDataAPI()
#' }
#' @export
view_datasets_MexicoDataAPI <- function() {
  # Check if the package is loaded
  if (!"MexicoDataAPI" %in% .packages()) {
    stop("The 'MexicoDataAPI' package must be loaded to view its datasets.")
  }

  # Extract dataset information
  datasets_info <- utils::data(package = "MexicoDataAPI")$results

  # Check if there are datasets available
  if (nrow(datasets_info) == 0) {
    message("No datasets are currently available in the 'MexicoDataAPI' package.")
    return(character(0))
  }

  # Extract dataset names
  datasets <- datasets_info[, "Item"]

  # Display the message with available datasets
  message("Datasets available in the 'MexicoDataAPI' package:")

  # Return a vector of datasets without printing to the console
  return(datasets)
}