R/deprecated.R

In poissonconsulting/term: Create, Manipulate and Query Parameter Terms

#' Deprecated Functions
#'
#' @inheritParams params
#' @keywords internal
#' @usage NULL
# nocov start
deprecated <- function(...) NULL
# nocov end


#' @describeIn deprecated Is Term
#'
#' `r lifecycle::badge("soft-deprecated")`
#'
#' Replace by [is_term()]
#' @export
is.term <- function(x) {
  deprecate_warn("0.1.0",
    what = "term::is.term()",
    with = "term::is_term()"
  )
  is_term(x)
}

#' @describeIn deprecated Is Incomplete Terms
#'
#' `r lifecycle::badge("soft-deprecated")`
#'
#' Replace by [is_incomplete_terms()]
#' @export
is.incomplete_terms <- function(x) {
  deprecate_warn("0.1.0",
    what = "term::is.incomplete_terms()",
    with = "term::is_incomplete_terms()"
  )
  is_incomplete_terms(x)
}

#' @describeIn deprecated Is Inconsistent Terms
#'
#' `r lifecycle::badge("soft-deprecated")`
#'
#' Replace by [is_inconsistent_terms()]
#' @export
is.inconsistent_terms <- function(x) {
  deprecate_warn("0.1.0",
    what = "term::is.inconsistent_terms()",
    with = "term::is_inconsistent_terms()"
  )
  is_inconsistent_terms(x)
}

#' @describeIn deprecated Get Parameters
#'
#' `r lifecycle::badge("soft-deprecated")`
#'
#' Replace by [pars()]
#' @export
parameters <- function(x, ...) {
  deprecate_warn("0.1.0",
    what = "parameters()",
    with = "pars()"
  )
  pars(x, ...)
}


#' @describeIn deprecated Setting Parameters
#'
#' `r lifecycle::badge("soft-deprecated")`
#'
#' Replace by pars<-
#' @export
`parameters<-` <- function(x, value) {
  deprecate_warn("0.1.0",
    what = "`parameters<-`()",
    with = "`pars<-`()"
  )
  pars(x) <- value
  x
}

#' @describeIn deprecated Set Parameters
#'
#' `r lifecycle::badge("soft-deprecated")`
#'
#' Replace by [set_pars()]
#' @export
set_parameters <- function(x, pars) {
  deprecate_warn("0.1.0",
    what = "term::set_parameters()",
    with = "term::set_pars()"
  )
  set_pars(x, pars)
}

#' @describeIn deprecated Term Index
#'
#' `r lifecycle::badge("soft-deprecated")`
#'
#' Replace by [tindex()]
#' @export
tdims <- function(x) {
  deprecate_warn("0.1.0",
    what = "term::tdims()",
    with = "term::tindex()"
  )
  tindex(x)
}