Merge pull request #64 from r-lib/f-43-deprecate

- `thisfile()` and related functions are soft-deprecated, now available in the whereami package (#43).

Author: krlmlr

DESCRIPTION

@@ -20,6 +20,7 @@ Imports:
     backports
 Suggests:
     knitr,
+    lifecycle,
     mockr,
     rmarkdown,
     testthat,

NAMESPACE

@@ -1,14 +1,12 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method("|",root_criterion)
-S3method(as.root_criterion,default)
 S3method(as_root_criterion,character)
 S3method(as_root_criterion,default)
 S3method(as_root_criterion,root_criterion)
 S3method(format,root_criterion)
 S3method(print,root_criterion)
 S3method(str,root_criteria)
-export(as.root_criterion)
 export(as_root_criterion)
 export(criteria)
 export(find_package_root_file)
@@ -23,7 +21,6 @@ export(has_basename)
 export(has_dir)
 export(has_file)
 export(has_file_pattern)
-export(is.root_criterion)
 export(is_drake_project)
 export(is_git_root)
 export(is_projectile_project)

R/criterion.R

@@ -116,27 +116,12 @@ is_root_criterion <- function(x) {
   inherits(x, "root_criterion")
 }
 
-#' @rdname deprecated
-#' @inheritParams is_root_criterion
-#' @export
-is.root_criterion <- function(x) {
-  .Deprecated("is_root_criterion")
-  is_root_criterion(x)
-}
-
 #' @rdname root_criterion
 #' @export
 as_root_criterion <- function(x) UseMethod("as_root_criterion", x)
 
-#' @rdname deprecated
-#' @export
-as.root_criterion <- function(x) {
-  .Deprecated("as_root_criterion")
-  UseMethod("as.root_criterion", x)
-}
-
 #' @details
-#' The `as.root_criterion()` function accepts objects of class
+#' The `as_root_criterion()` function accepts objects of class
 #' `root_criterion`, and character values; the latter will be
 #' converted to criteria using `has_file`.
 #'
@@ -155,11 +140,6 @@ as_root_criterion.default <- function(x) {
   stop("Cannot coerce ", x, " to type root_criterion.", call. = FALSE)
 }
 
-#' @export
-as.root_criterion.default <- function(x) {
-  as_root_criterion(x)
-}
-
 #' @export
 format.root_criterion <- function(x, ...) {
   if (length(x$desc) > 1) {

R/deprecated.R

@@ -1,6 +1,6 @@
 #' @details
 #' See the "Value" section in [root_criterion()] for documentation
-#' of root criterion objects, and  [criteria()] for useful predefined
+#' of root criterion objects, and  [criteria] for useful predefined
 #' root criteria.
 #'
 #' @examples
@@ -11,5 +11,4 @@
 #' root_fun("NAMESPACE")
 #' }
 #' @import backports
-#' @api
 "_PACKAGE"

R/rprojroot-package.R

@@ -1,5 +1,9 @@
-#' @title Determines the path of the currently running script
-#' @description \R does not store nor export the path of the currently running
+#' Determines the path of the currently running script
+#'
+#' @description
+#' `r lifecycle::badge("soft-deprecated")`
+#'
+#' \R does not store nor export the path of the currently running
 #'   script.  This is an attempt to circumvent this limitation by applying
 #'   heuristics (such as call stack and argument inspection) that work in many
 #'   cases.
@@ -12,17 +16,29 @@
 #'   or run with `Rscript` or using the `--file` parameter to the
 #'   `R` executable.  For code run with `Rscript`, the exact value
 #'   of the parameter passed to `Rscript` is returned.
+#'
+#' @section Life cycle:
+#'
+#' These functions are now available in the \pkg{whereami} package.
+#'
 #' @return The path of the currently running script, NULL if it cannot be
 #'   determined.
 #' @seealso [base::source()], [utils::Rscript()], [base::getwd()]
 #' @references [https://stackoverflow.com/q/1815606/946850]()
 #' @author Kirill Müller, Hadley Wickham, Michael R. Head
+#' @keywords internal
 #' @examples
 #' \dontrun{
 #' thisfile()
 #' }
 #' @export
 thisfile <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile()",
+    "whereami::thisfile()"
+  )
+
   if (!is.null(res <- thisfile_source())) {
     res
   } else if (!is.null(res <- thisfile_r())) {
@@ -39,6 +55,12 @@ thisfile <- function() {
 #' @rdname thisfile
 #' @export
 thisfile_source <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile_source()",
+    "whereami::thisfile_source()"
+  )
+
   for (i in -(1:sys.nframe())) {
     if (identical(args(sys.function(i)), args(base::source))) {
       return(normalizePath(sys.frame(i)$ofile))
@@ -52,6 +74,12 @@ thisfile_source <- function() {
 #' @importFrom utils tail
 #' @export
 thisfile_r <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile_r()",
+    "whereami::thisfile_r()"
+  )
+
   cmd_args <- commandArgs(trailingOnly = FALSE)
   if (!grepl("^R(?:|term)(?:|[.]exe)$", basename(cmd_args[[1L]]), ignore.case = TRUE)) {
     return(NULL)
@@ -77,6 +105,12 @@ thisfile_r <- function() {
 #' @importFrom utils tail
 #' @export
 thisfile_rscript <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile_rscript()",
+    "whereami::thisfile_rscript()"
+  )
+
   cmd_args <- commandArgs(trailingOnly = FALSE)
   if (!grepl("^R(?:term|script)(?:|[.]exe)$", basename(cmd_args[[1L]]), ignore.case = TRUE)) {
     return(NULL)
@@ -100,6 +134,12 @@ thisfile_rscript <- function() {
 #' @rdname thisfile
 #' @export
 thisfile_knit <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile_knit()",
+    "whereami::thisfile_knit()"
+  )
+
   if (requireNamespace("knitr")) {
     return(knitr::current_input(dir = TRUE))
   }