R/off.R

In Torvaney/regista: Soccer Analytics

#' Helper functions to enable easier model specification
#'
#' @description
#' Modelling team strengths often requires separate parameters for offence and
#' defence. These helper functions provide a quick way to turn a factor of team
#' names into a factor of offence or defence levels
#'
#' @param x A factor containing team names
#'
#' @examples
#' teams <- factor(c("Arsenal", "Liverpool", "Barcelona", "Dortmund"))
#' off(teams)
#' #> [1] off___Arsenal   off___Liverpool off___Barcelona off___Dortmund
#' #> Levels: off___Arsenal off___Barcelona off___Dortmund off___Liverpool
#'
#' @importFrom forcats fct_relabel
#' @export
off <- function(x) {
  fct_relabel(x, .off_str)
}

#' @rdname off
#' @importFrom forcats fct_relabel
#' @export
def <- function(x) {
  fct_relabel(x, .def_str)
}

#' @keywords internal
.off_str <- function(x) {
  paste0("off___", x)
}

#' @keywords internal
.def_str <- function(x) {
  paste0("def___", x)
}