minor doc fixes

R/get_vars_for_dataset.R

@@ -98,7 +98,7 @@ check_available_variable <- function(variable, dataset) {
 #' @param variable string defining the variable name
 #' @param dataset string defining dataset to be downloaded
 #' @returns the name of the variable
-#'
+#' @keywords internal
 
 get_varname <- function(variable, dataset) {
   return(getOption("pastclim.dataset_list")$ncvar[getOption("pastclim.dataset_list")$variable == variable &

R/location_slice.R

@@ -83,7 +83,7 @@ location_slice <-
 #'
 #' @param ... arguments to be passed to [location_slice()]
 #' @returns a data.frame with the climatic variables of interest
-#'
+#' @keywords deprecated
 #' @export
 
 climate_for_locations <- function(...) {

R/location_slice_from_region_series.R

@@ -195,27 +195,6 @@ location_slice_from_region_series <-
   }
 
 
-#' Extract local climate for one or more locations for a given time slice.
-#'
-#' Deprecated version of [location_slice()]
-#'
-#' @param ... arguments to be passed to [location_slice()]
-#' @returns a data.frame with the climatic variables of interest
-#'
-#' @export
-
-climate_for_locations <- function(...) {
-  warning("DEPRECATED: use 'location_slice' instead")
-  # if (!is.null(path_to_nc)) {
-  #   stop(
-  #     "the use of pastclimData is now deprecated",
-  #     "use 'set_path_data' instead"
-  #   )
-  # }
-  location_slice(...)
-}
-
-
 #' Mode
 #'
 #' Find the mode of vector x (note that, if multiple values have the same

R/region_slice.R

@@ -61,7 +61,7 @@ region_slice <-
 #' @returns a
 #' SpatRaster [`terra::SpatRaster`] object, with
 #' each variable as a layer.
-#'
+#' @keywords deprecated
 #' @export
 
 climate_for_time_slice <- function(...) {

data-raw/temp/restructure_reference_pkgdown

@@ -0,0 +1,51 @@
+reference:
+  - title: "Getting datasets"
+    desc: "Functions to download datasets"
+    contents: 
+      - get_available_datasets
+      - list_available_datasets
+      - get_vars_for_dataset
+      - download_dataset
+      - update_dataset_list
+      - get_data_path
+      - set_data_path
+      - clean_data_path
+  - title: "Extracting climate"
+    desc: "Functions for extracting climate info."
+    contents:
+      - location_slice
+      - location_series
+      - region_slice
+      - region_series
+      - slice_region_series
+      - df_from_region_series
+      - df_from_region_slice
+      - get_biome_classes
+      - get_ice_mask
+      - get_land_mask
+      - is_region_series
+      - get_time_bp_steps
+      - get_mis_time_steps
+      - validate_nc
+  - title: "Computing additional variables"
+    desc: "Functions for compute new variables from climate"
+    contents:
+      - bioclim_vars
+      - distance_from_sea
+      - koeppen_geiger
+  - title: "Useful info to cut datasets"
+    desc: "Functions for compute new variables from climate"
+    contents:
+      - region_extent
+      - region_outline
+      - region_outline_union
+      - mis_boundaries
+  - title: "Datasets"
+    desc: "Documentation for datasets available in pastclim"
+    contents:
+      - Barreto2023
+      - Beyer2020
+      - Example
+      - HYDE_3.3_baseline
+      - Krapp2021
+      - WorldClim_2.1