From 7ac6cb9cba65a44386c8db718251a0666641c695 Mon Sep 17 00:00:00 2001 From: Mahony Date: Fri, 23 Aug 2024 11:04:50 -0700 Subject: [PATCH] fixed error in roxygen documentation for list_runs_* functions. +redoc --- R/data-lists.R | 4 ++-- man/data-option-lists.Rd | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/data-lists.R b/R/data-lists.R index b687e3e..8ad368b 100644 --- a/R/data-lists.R +++ b/R/data-lists.R @@ -38,7 +38,7 @@ list_gcm_periods <- function() { #' @description -#' lists available runs for a given GCM/ssp. +#' `list_runs_ssp` lists available runs for a given GCM/ssp. #' @param gcm Name of GCM. Must be one of the elements in list_gcms(). #' @param ssp Name of scenario Must be one of the elements in list_ssps(). #' @importFrom data.table fread @@ -53,7 +53,7 @@ list_runs_ssp <- function(gcm, ssp){ } #' @description -#' lists available runs from the historical simulation (1851-2014) for a specified GCM. +#' `list_runs_historic` lists available runs from the historical simulation (1851-2014) for a specified GCM. #' @param gcm Name of GCM #' @importFrom data.table fread #' @importFrom tools R_user_dir diff --git a/man/data-option-lists.Rd b/man/data-option-lists.Rd index 6e9581b..6ffbe04 100644 --- a/man/data-option-lists.Rd +++ b/man/data-option-lists.Rd @@ -55,9 +55,9 @@ a character vector. \code{list_gcm_periods} lists available 20-year normal periods for GCM simulations. -lists available runs for a given GCM/ssp. +\code{list_runs_ssp} lists available runs for a given GCM/ssp. -lists available runs from the historical simulation (1851-2014) for a specified GCM. +\code{list_runs_historic} lists available runs from the historical simulation (1851-2014) for a specified GCM. \code{list_refmaps} lists available reference maps of gridded climate normals