Skip to contents

Helpers for building an R package

Source: vignettes/package_helpers.Rmd
package_helpers.Rmd

Response to an input check

The input_check_response() function standardizes responses to input checks, ensuring consistency.

x <- "1"
y <- 1

### check is successful
input_check_response(
  check = checkmate::check_character(x),
  var_name = "x",
  error = TRUE
)
#> [1] TRUE

### standardized check response
input_check_response(
  check = checkmate::check_character(y),
  var_name = "y",
  error = TRUE
)
#> Error:
#> ! Input `y` is bad: Must be of type 'character', not 'double'

The package_logo() function makes it easy to create a very basic package logo. Setting use_logo = TRUE will run usethis::use_logo() to set up the logo for your package.

package_logo(
  package_name = "package",
  brackets = TRUE,
  use_logo = FALSE
)