diff --git a/R/conversion_2.R b/R/conversion_2.R index 21cdc14..33d2a1a 100644 --- a/R/conversion_2.R +++ b/R/conversion_2.R @@ -5,7 +5,7 @@ #' @param se Standard error of the `beta` estimate, numeric vector of length 1 #' @param response_transformation Character string describing transformation #' @param link_fun Character string describing link function -#' @param sim Number of simulations to use during back-transformation. Defaults to $10000$. +#' @param sim Number of simulations to use during back-transformation. Defaults to `10000`. #' #' @return The outputs of a back-transformation function, see family back-transformations #' @export diff --git a/R/make_param_table.R b/R/make_param_table.R index eddf269..ac719a9 100644 --- a/R/make_param_table.R +++ b/R/make_param_table.R @@ -16,7 +16,7 @@ #' #' @details # Note #' Currently variable names of `analysis_data` must not contain `.` because this character is used to split the `variable` from the `parameter` during `pivot_longer()` -#' @seealso The table from this function is used to standardize out-of-sample predictions $y_i$ in [pred_to_Z()] +#' @seealso The table from this function is used to standardize out-of-sample predictions \eqn{y_i} in [pred_to_Z()] make_param_table <- function(analysis_data, na.rm = TRUE) { out <- analysis_data %>% ungroup() %>% diff --git a/R/multi_level_mod_calcs.R b/R/multi_level_mod_calcs.R index 76172a7..ec08ffa 100644 --- a/R/multi_level_mod_calcs.R +++ b/R/multi_level_mod_calcs.R @@ -16,7 +16,7 @@ calc_I2_ml <- function(fitted_model) { } #' Apportion heterogeneity of a multi-level meta-analytic model -#' @description Estimates how much the total variance $I^2$ can be attributed to between- and within- cluster heterogeneity separately. +#' @description Estimates how much the total variance \eqn{I^2} can be attributed to between- and within- cluster heterogeneity separately. #' @details From [http://www.metafor-project.org/doku.php/tips:i2_multilevel_multivariate](http://www.metafor-project.org/doku.php/tips:i2_multilevel_multivariate) #' @param fitted_model #' diff --git a/R/prepare_ManyEcoEvo_yi.R b/R/prepare_ManyEcoEvo_yi.R index 655c2a0..f5cc519 100644 --- a/R/prepare_ManyEcoEvo_yi.R +++ b/R/prepare_ManyEcoEvo_yi.R @@ -5,11 +5,10 @@ #' @param all_review_data Review data for all `dataset`s contained in `master_data_raw`, generated by `prepare_review_data`. #' @param all_prediction_data Prediction data for all `dataset`s contained in a `tibble` #' @param ManyEcoEvo ManyEcoEvo data generated by `prepare_ManyEcoEvo` -#' @return A tibble of ManyEcoEvo analyst response data with out-of-sample predictions ($y_i$). +#' @return A tibble of ManyEcoEvo analyst response data with out-of-sample predictions (\eqn{y_i}). #' @export #' @family targets-pipeline functions #' @family Multi-dataset Wrapper Functions - prepare_ManyEcoEvo_yi <- function(master_data_raw, master_raw_metadata, all_prediction_data) { diff --git a/R/utils.R b/R/utils.R index dd5933a..8c3fdcc 100644 --- a/R/utils.R +++ b/R/utils.R @@ -52,7 +52,7 @@ subset_fns_Zr <- function() { # TODO update calling of this fn (switch to fn rat #' #' @description Generates a list of functions that are used to subset the #' processed ManyEcoEvo dataset (e.g.`data(ManyEcoEvo_results`) containing -#' out-of-sample predictions $y_i$. +#' out-of-sample predictions \eqn{y_i}. #' #' @details #' The subset functions are used to filter out predictions that are not