R/zzz-deprecated.R

In renderthis: Render Slides to Different Formats

#' Deprecated Build Functions
#'
#' @description
#' `r lifecycle::badge("deprecated")`
#'
#' \pkg{renderthis}, under the name \pkg{xaringanBuilder}, previously provided
#' the same functionality using `build_` functions. To be consistent with the
#' new package name, these function names have also been changed.
#'
#' * `build_html()` is now [to_html()]
#' * `build_pdf()` is now [to_pdf()]
#' * `build_png()` is now [to_png()]
#' * `build_gif()` is now [to_gif()]
#' * `build_mp4()` is now [to_mp4()]
#' * `build_pptx()` is now [to_pptx()]
#' * `build_social()` is now [to_social()]
#'
#' **Argument names.** Note that the `input` and `output_file` arguments of
#' these functions have also been renamed. They are now named `from` and `to`.
#'
#' @param ... Parameters passed to the new `to_*()` function
#' @return See the corresponding new function for the appropriate return value.
#'
#' @name deprecated-build
#' @keywords internal
NULL

deprecate_function <- function(old, new) {
    function(...) {
        lifecycle::deprecate_warn(
            when = "0.1.0",
            what = sprintf("%s()", old),
            with = sprintf("%s()", new)
        )
        args <- list(...)
        fmls <- formals(eval(parse(text = new)))

        # warn `input/output_file` -> `from/to` argument name change
        changes <- c(input = "from", output_file = "to")
        for (i in seq_along(changes)) {
            old_arg <- names(changes)[i]
            new_arg <- unname(changes)[i]
            if (old_arg %in% names(args) && new_arg %in% names(fmls)) {
                lifecycle::deprecate_warn(
                    when = "0.1.0",
                    what = sprintf("%s(%s = )", old, old_arg),
                    with = sprintf("%s(%s = )", new, new_arg),
                )
                args[[new_arg]] <- args[[old_arg]]
                args[[old_arg]] <- NULL
            }
        }

        do.call(new, args, envir = parent.frame())
    }
}

#' @rdname deprecated-build
#' @export
build_html <- deprecate_function("build_html", "to_html")

#' @rdname deprecated-build
#' @export
build_pdf <- deprecate_function("build_pdf", "to_pdf")

#' @rdname deprecated-build
#' @export
build_png <- deprecate_function("build_png", "to_png")

#' @rdname deprecated-build
#' @export
build_gif <- deprecate_function("build_gif", "to_gif")

#' @rdname deprecated-build
#' @export
build_mp4 <- deprecate_function("build_mp4", "to_mp4")

#' @rdname deprecated-build
#' @export
build_pptx <- deprecate_function("build_pptx", "to_pptx")

#' @rdname deprecated-build
#' @export
build_social <- deprecate_function("build_social", "to_social")