Skip to content

Commit

Permalink
- docs!: #102 add roxygen imports to function doc
Browse files Browse the repository at this point in the history
  • Loading branch information
egouldo committed Sep 9, 2024
1 parent a07389f commit a51c526
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
11 changes: 10 additions & 1 deletion R/augment_prediction_data.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#' 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 of individual analyst submission containing augmented
Expand All @@ -16,6 +16,15 @@
#' @examples
#' # for testing and dev purposes:
#' # safe_augment <- purrr:::safely(augment_prediction_data)
#' @import dplyr
#' @importFrom cli cli_abort cli_alert
#' @importFrom purrr flatten_df flatten_chr
#' @importFrom stringr str_detect
#' @importFrom purrr set_names
#' @importFrom tibble tibble
#' @importFrom readr parse_number locale
#' @importFrom tidyr drop_na
#' @importFrom rlang is_na
augment_prediction_data <- function(.data, checks, dataset) {
if (is.logical(.data)) {
return(NA)
Expand Down
3 changes: 3 additions & 0 deletions R/convert_predictions.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
#' @importFrom cli cli_alert_warning cli_abort
#' @importFrom data.table setnames
#' @importFrom pointblank has_columns
#' @importFrom tibble tibble deframe
#' @importFrom purrr discard
#' @importFrom tidyselect any_of
#' @family Back-transformation
#' @seealso [rename_prediction_cols()]
convert_predictions <- function(augmented_data,
Expand Down

0 comments on commit a51c526

Please sign in to comment.