diff --git a/R/data-process.R b/R/data-process.R index 006f7aa..d6206cd 100644 --- a/R/data-process.R +++ b/R/data-process.R @@ -15,7 +15,7 @@ #' data_weighted <- gen_data_mean(data) #' ``` #' -#' 3. **`gen_data_weighted_rf`**: Calculates the differences between intervention and baseline values for various metrics. +#' 3. **`gen_data_weighted_rf`**: Calculates the differences between intervention and baseline values for risk factors. #' ```r #' data_weighted_rf_wide_collapse <- gen_data_weighted_rf(data_weighted) #' ``` @@ -30,7 +30,7 @@ #' data_weighted_burden_wide_collapse <- gen_data_weighted_burden(data_weighted) #' ``` #' -#'6. **`gen_data_weighted_burden_spline`**: Performs data smoothing. +#'6. **`gen_data_weighted_burden_spline`**: Performs data smoothing for burden of disease, when necessary. For instance, with only a few simulations, there can be positive values in difference in burden of disease. #' ```r #' data_weighted_burden_spline <- gen_data_weighted_burden_spline(data_weighted_burden_wide_collapse) #' ``` @@ -113,7 +113,7 @@ gen_data_weighted <- function(data) { #' Calculate Differences for Various Metrics #' -#' This function calculates the differences between intervention and baseline values for various metrics. +#' This function calculates the differences between intervention and baseline values for risk factors. #' #' @param data_weighted A data frame containing weighted mean values for various metrics. #' @return A data frame with differences between intervention and baseline values for various metrics. @@ -281,7 +281,7 @@ gen_data_weighted_burden <- function(data_weighted) { #' Perform data smoothing #' -#' This function performs data smoothing. +#' This function performs data smoothing for burden of disease, when necessary. For instance, with only a few simulations, there can be positive values in difference in burden of disease. #' #' @param data_weighted_burden A data frame containing weighted values for burden of disease. #' @return A data frame with spline smoothing applied for burden of disease. diff --git a/man/DataProcessing.Rd b/man/DataProcessing.Rd index 74b5532..4602878 100644 --- a/man/DataProcessing.Rd +++ b/man/DataProcessing.Rd @@ -20,7 +20,7 @@ Below is a description of how to use these functions in sequence. data_weighted <- gen_data_mean(data) ``` -3. **`gen_data_weighted_rf`**: Calculates the differences between intervention and baseline values for various metrics. +3. **`gen_data_weighted_rf`**: Calculates the differences between intervention and baseline values for risk factors. ```r data_weighted_rf_wide_collapse <- gen_data_weighted_rf(data_weighted) ``` @@ -35,7 +35,7 @@ Below is a description of how to use these functions in sequence. data_weighted_burden_wide_collapse <- gen_data_weighted_burden(data_weighted) ``` -6. **`gen_data_weighted_burden_spline`**: Performs data smoothing. +6. **`gen_data_weighted_burden_spline`**: Performs data smoothing for burden of disease, when necessary. For instance, with only a few simulations, there can be positive values in difference in burden of disease. ```r data_weighted_burden_spline <- gen_data_weighted_burden_spline(data_weighted_burden_wide_collapse) ``` diff --git a/man/gen_data_weighted_burden_spline.Rd b/man/gen_data_weighted_burden_spline.Rd index 61764c7..c3dbe7a 100644 --- a/man/gen_data_weighted_burden_spline.Rd +++ b/man/gen_data_weighted_burden_spline.Rd @@ -13,5 +13,5 @@ gen_data_weighted_burden_spline(data_weighted_burden) A data frame with spline smoothing applied for burden of disease. } \description{ -This function performs data smoothing. +This function performs data smoothing for burden of disease, when necessary. For instance, with only a few simulations, there can be positive values in difference in burden of disease. } diff --git a/man/gen_data_weighted_rf.Rd b/man/gen_data_weighted_rf.Rd index 9253f1e..3b23c1a 100644 --- a/man/gen_data_weighted_rf.Rd +++ b/man/gen_data_weighted_rf.Rd @@ -13,5 +13,5 @@ gen_data_weighted_rf(data_weighted) A data frame with differences between intervention and baseline values for various metrics. } \description{ -This function calculates the differences between intervention and baseline values for various metrics. +This function calculates the differences between intervention and baseline values for risk factors. }