docs: #102 update documentation

R/augment_prediction_data.R

@@ -6,10 +6,10 @@
 #' Where there are missing variables in `.data` or `checks` is missing,
 #' `NA` will be returned for the augmented prediction data instead.
 #' @param .data A data.frame of out of-sample-predictions analyst submission data
-#' @param checks A data.frame of pointblank interrogation output for `.data`
+#' @param checks A data.frame of [pointblank::] interrogation output for `.data`
 #' @param dataset A character string equal to either "blue tit" or "eucalyptus"
 #'
-#' @return A dataframe. Individual analyst submission containing augmented
+#' @return A dataframe of individual analyst submission containing augmented
 #' out-of-sample prediction data ready for meta-analysis.
 #' @export
 #'

R/convert_predictions.R

@@ -1,7 +1,7 @@
 #' Convert Predictions
-#' @description Converts out of sample predictions on the link scale back to the response scale
+#' @description Converts out-of-sample predictions on the link scale back to the response scale
 #' @param augmented_data A tibble of out of analyst's sample prediction data for 3 scenarios
-#' @return A tibble of out of sample predictions on the response variable scale of the response variable used by the analyst
+#' @return A tibble of out-of-sample predictions on the response variable scale of the response variable used by the analyst
 #' @family Analysis-level functions
 #' @export
 #' @import dplyr