From 251af6929757b9dee661834dd8e73c11ed046555 Mon Sep 17 00:00:00 2001 From: rafapereirabr Date: Mon, 8 Aug 2022 22:43:53 -0300 Subject: [PATCH] hide internal functions --- r-package/DESCRIPTION | 2 +- r-package/NAMESPACE | 7 ------- r-package/R/download_metadata.R | 3 +-- r-package/R/utils.R | 20 ++++++------------- r-package/man/check_connection.Rd | 10 +--------- r-package/man/download_gpkg.Rd | 10 +--------- r-package/man/download_metadata.Rd | 6 +----- r-package/man/list_geobr.Rd | 4 ---- r-package/man/load_gpkg.Rd | 10 +--------- r-package/man/select_data_type.Rd | 10 +--------- r-package/man/select_metadata.Rd | 10 +--------- r-package/man/select_year_input.Rd | 10 +--------- r-package/tests/testthat.R | 4 ++++ .../tests/testthat/test-check_connection.R | 8 ++++---- 14 files changed, 23 insertions(+), 91 deletions(-) diff --git a/r-package/DESCRIPTION b/r-package/DESCRIPTION index d1161a7e..deab668b 100644 --- a/r-package/DESCRIPTION +++ b/r-package/DESCRIPTION @@ -43,6 +43,6 @@ Imports: httr (>= 1.4.1), sf (>= 0.9-3), utils -RoxygenNote: 7.2.0 +RoxygenNote: 7.2.1 Roxygen: list(markdown = TRUE) VignetteBuilder: knitr diff --git a/r-package/NAMESPACE b/r-package/NAMESPACE index 6a5244cb..cf7f3aeb 100644 --- a/r-package/NAMESPACE +++ b/r-package/NAMESPACE @@ -1,11 +1,7 @@ # Generated by roxygen2: do not edit by hand export(cep_to_state) -export(check_connection) -export(download_gpkg) -export(download_metadata) export(list_geobr) -export(load_gpkg) export(lookup_muni) export(read_amazon) export(read_biomes) @@ -34,9 +30,6 @@ export(read_statistical_grid) export(read_urban_area) export(read_urban_concentrations) export(read_weighting_area) -export(select_data_type) -export(select_metadata) -export(select_year_input) importFrom(curl,"has_internet") importFrom(data.table,"%like%") importFrom(utils,"tail") diff --git a/r-package/R/download_metadata.R b/r-package/R/download_metadata.R index eb89bcc1..99d733d6 100644 --- a/r-package/R/download_metadata.R +++ b/r-package/R/download_metadata.R @@ -1,7 +1,6 @@ #' Support function to download metadata internally used in geobr #' -#' @export -#' @family general support functions +#' @keywords internal #' @examples \dontrun{ if (interactive()) { #' df <- download_metadata() #' }} diff --git a/r-package/R/utils.R b/r-package/R/utils.R index cbcdc3ed..c8c8df37 100644 --- a/r-package/R/utils.R +++ b/r-package/R/utils.R @@ -8,8 +8,7 @@ #' #' @param temp_meta A dataframe with the file_url addresses of geobr datasets #' @param simplified Logical TRUE or FALSE indicating whether the function returns the 'original' dataset with high resolution or a dataset with 'simplified' borders (Defaults to TRUE) -#' @export -#' @family support functions +#' @keywords internal #' select_data_type <- function(temp_meta, simplified=NULL){ @@ -29,12 +28,9 @@ select_data_type <- function(temp_meta, simplified=NULL){ #' Select year input #' -#' -#' #' @param temp_meta A dataframe with the file_url addresses of geobr datasets #' @param y Year of the dataset (passed by red_ function) -#' @export -#' @family support functions +#' @keywords internal #' select_year_input <- function(temp_meta, y=year){ @@ -60,8 +56,7 @@ select_year_input <- function(temp_meta, y=year){ #' @param simplified Logical TRUE or FALSE indicating whether the function returns the 'original' dataset with high resolution or a dataset with 'simplified' borders (Defaults to TRUE) #' @param year Year of the dataset (passed by red_ function) #' -#' @export -#' @family support functions +#' @keywords internal #' @examples \dontrun{ if (interactive()) { #' #' library(geobr) @@ -97,8 +92,7 @@ select_metadata <- function(geography, year=NULL, simplified=NULL){ #' #' @param file_url A string with the file_url address of a geobr dataset #' @param progress_bar Logical. Defaults to (TRUE) display progress bar -#' @export -#' @family support functions +#' @keywords internal #' download_gpkg <- function(file_url, progress_bar = showProgress){ @@ -237,8 +231,7 @@ download_gpkg <- function(file_url, progress_bar = showProgress){ #' #' @param file_url A string with the file_url address of a geobr dataset #' @param temps The address of a gpkg file stored in tempdir. Defaults to NULL -#' @export -#' @family support functions +#' @keywords internal #' load_gpkg <- function(file_url, temps=NULL){ @@ -278,8 +271,7 @@ load_gpkg <- function(file_url, temps=NULL){ #' #' @return Logical. `TRUE` if url is working, `FALSE` if not. #' -#' @export -#' @family support functions +#' @keywords internal #' check_connection <- function(file_url = 'https://www.ipea.gov.br/geobr/metadata/metadata_gpkg.csv'){ diff --git a/r-package/man/check_connection.Rd b/r-package/man/check_connection.Rd index 5e07fe67..68ebaa5d 100644 --- a/r-package/man/check_connection.Rd +++ b/r-package/man/check_connection.Rd @@ -17,12 +17,4 @@ Logical. \code{TRUE} if url is working, \code{FALSE} if not. \description{ Check internet connection with Ipea server } -\seealso{ -Other support functions: -\code{\link{download_gpkg}()}, -\code{\link{load_gpkg}()}, -\code{\link{select_data_type}()}, -\code{\link{select_metadata}()}, -\code{\link{select_year_input}()} -} -\concept{support functions} +\keyword{internal} diff --git a/r-package/man/download_gpkg.Rd b/r-package/man/download_gpkg.Rd index 133cdbe8..c771249f 100644 --- a/r-package/man/download_gpkg.Rd +++ b/r-package/man/download_gpkg.Rd @@ -14,12 +14,4 @@ download_gpkg(file_url, progress_bar = showProgress) \description{ Download geopackage to tempdir } -\seealso{ -Other support functions: -\code{\link{check_connection}()}, -\code{\link{load_gpkg}()}, -\code{\link{select_data_type}()}, -\code{\link{select_metadata}()}, -\code{\link{select_year_input}()} -} -\concept{support functions} +\keyword{internal} diff --git a/r-package/man/download_metadata.Rd b/r-package/man/download_metadata.Rd index 1ed49255..d3441d24 100644 --- a/r-package/man/download_metadata.Rd +++ b/r-package/man/download_metadata.Rd @@ -14,8 +14,4 @@ Support function to download metadata internally used in geobr df <- download_metadata() }} } -\seealso{ -Other general support functions: -\code{\link{list_geobr}()} -} -\concept{general support functions} +\keyword{internal} diff --git a/r-package/man/list_geobr.Rd b/r-package/man/list_geobr.Rd index 85f3bd32..f04ca744 100644 --- a/r-package/man/list_geobr.Rd +++ b/r-package/man/list_geobr.Rd @@ -17,8 +17,4 @@ Returns a data frame with all datasets available in the geobr package df <- list_geobr() } } -\seealso{ -Other general support functions: -\code{\link{download_metadata}()} -} \concept{general support functions} diff --git a/r-package/man/load_gpkg.Rd b/r-package/man/load_gpkg.Rd index 2eaa8232..338ea13d 100644 --- a/r-package/man/load_gpkg.Rd +++ b/r-package/man/load_gpkg.Rd @@ -14,12 +14,4 @@ load_gpkg(file_url, temps = NULL) \description{ Load geopackage from tempdir to global environment } -\seealso{ -Other support functions: -\code{\link{check_connection}()}, -\code{\link{download_gpkg}()}, -\code{\link{select_data_type}()}, -\code{\link{select_metadata}()}, -\code{\link{select_year_input}()} -} -\concept{support functions} +\keyword{internal} diff --git a/r-package/man/select_data_type.Rd b/r-package/man/select_data_type.Rd index 4ce8fe7c..496fc184 100644 --- a/r-package/man/select_data_type.Rd +++ b/r-package/man/select_data_type.Rd @@ -14,12 +14,4 @@ select_data_type(temp_meta, simplified = NULL) \description{ Select data type: 'original' or 'simplified' (default) } -\seealso{ -Other support functions: -\code{\link{check_connection}()}, -\code{\link{download_gpkg}()}, -\code{\link{load_gpkg}()}, -\code{\link{select_metadata}()}, -\code{\link{select_year_input}()} -} -\concept{support functions} +\keyword{internal} diff --git a/r-package/man/select_metadata.Rd b/r-package/man/select_metadata.Rd index 90949e99..4ce2ded5 100644 --- a/r-package/man/select_metadata.Rd +++ b/r-package/man/select_metadata.Rd @@ -26,12 +26,4 @@ df <- download_metadata() }} } -\seealso{ -Other support functions: -\code{\link{check_connection}()}, -\code{\link{download_gpkg}()}, -\code{\link{load_gpkg}()}, -\code{\link{select_data_type}()}, -\code{\link{select_year_input}()} -} -\concept{support functions} +\keyword{internal} diff --git a/r-package/man/select_year_input.Rd b/r-package/man/select_year_input.Rd index 008ff129..236a4b3f 100644 --- a/r-package/man/select_year_input.Rd +++ b/r-package/man/select_year_input.Rd @@ -14,12 +14,4 @@ select_year_input(temp_meta, y = year) \description{ Select year input } -\seealso{ -Other support functions: -\code{\link{check_connection}()}, -\code{\link{download_gpkg}()}, -\code{\link{load_gpkg}()}, -\code{\link{select_data_type}()}, -\code{\link{select_metadata}()} -} -\concept{support functions} +\keyword{internal} diff --git a/r-package/tests/testthat.R b/r-package/tests/testthat.R index 3d499ff7..f4d3fd8f 100644 --- a/r-package/tests/testthat.R +++ b/r-package/tests/testthat.R @@ -1,5 +1,9 @@ +if (requireNamespace("testthat", quietly = TRUE)) { + library(testthat) library(geobr) library(sf) test_check("geobr") + +} diff --git a/r-package/tests/testthat/test-check_connection.R b/r-package/tests/testthat/test-check_connection.R index 5d933bf9..5b74a381 100644 --- a/r-package/tests/testthat/test-check_connection.R +++ b/r-package/tests/testthat/test-check_connection.R @@ -5,15 +5,15 @@ skip_if(Sys.getenv("TEST_ONE") != "") testthat::skip_on_cran() -url_ok <- 'http://google.com/' -url_timeout <- 'http://www.google.com:81/' -url_error <- 'http://httpbin.org/status/300' +url_ok <- 'https://google.com/' +url_timeout <- 'https://www.google.com:81/' +url_error <- 'https://httpbin.org/status/300' # expected success ------------------------------------ test_that("check_connection", { - testthat::expect_true(check_connection(file_url = url_ok) ) + testthat::expect_true( check_connection(file_url = url_ok) ) })