Deprecate rjournal rticle in favor of rjtools (#531)

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: rticles
 Title: Article Formats for R Markdown
-Version: 0.24.12
+Version: 0.24.13
 Authors@R: c(
     person("JJ", "Allaire", , "jj@posit.co", role = "aut"),
     person("Yihui", "Xie", , "xie@yihui.name", role = "aut",
@@ -88,9 +88,11 @@ URL: https://github.com/rstudio/rticles
 BugReports: https://github.com/rstudio/rticles/issues
 Imports: 
     knitr (>= 1.30),
+    lifecycle,
     rmarkdown (>= 2.14),
     tinytex (>= 0.30),
     utils,
+    withr,
     xfun,
     yaml
 Suggests: 

NEWS.md

@@ -4,6 +4,8 @@
 
 - `ajs_article()` and `jss_article()` require Pandoc 2.7+ (possibly required by some changes in `jss.cls`)
 
+- `rjournal_article()` is now soft deprecated in favor of `rjtools::rjournal_pdf_article()` as **rjtools** package is now the recommended workflow at <https://rjournal.github.io/submissions.html>
+
 ## NEW FEATURES
 
 - `ieee_article()` now supports several affiliations per `authors` when using the `wide: true` mode (thanks, @phamdn, #500).

R/rjournal_article.R

@@ -1,13 +1,21 @@
 #' R Journal format.
 #'
+#' @description
+#' `r lifecycle::badge('deprecated')`
+#'
+#' This function is now deprecated in favor of the [**rjtools**](https://rjournal.github.io/rjtools/) package
+#' which is now officialy recommanded by R Journal <https://rjournal.github.io/submissions.html>. See below for document
+#'
+#' @details # About this format and the R Journal requirements
+#'
 #' Format for creating R Journal articles. Adapted from
 #' <https://journal.r-project.org/submissions.html>.
 #'
 #' This file is only a basic article template. For full details of _The R
 #' Journal_ style and information on how to prepare your article for submission,
 #' see the [Instructions for Authors](https://journal.r-project.org/share/author-guide.pdf)
 #'
-#' ## About this format and the R Journal requirements
+
 #'
 #' `rticles::rjournal_article` will help you build the correct files requirements:
 #'
@@ -51,6 +59,8 @@
 #' @param ... Arguments to [rmarkdown::pdf_document()].
 #' @export
 rjournal_article <- function(..., keep_tex = TRUE, citation_package = "natbib") {
+
+  lifecycle::deprecate_warn("0.25", "rjournal_article()", "rjtools::rjournal_pdf_article()", details = "See official recommandation at https://rjournal.github.io/submissions.html")
   rmarkdown::pandoc_available("2.2", TRUE)
 
   base <- pdf_document_format(

tests/testit/test-formats.R

@@ -1,5 +1,7 @@
 test_format <- function(name, output_options = NULL, skip = NULL) {
 
+  withr::local_options(lifecycle_verbosity = "quiet")
+
   # don't run on CRAN due to complicated dependencies (Pandoc/LaTeX packages)
   if (!identical(Sys.getenv("NOT_CRAN"), "true")) return()
   # skip if requested

tests/testthat/test-rjournal_article.R

@@ -0,0 +1,5 @@
+test_that("rjournal_article() is deprecated", {
+  expect_snapshot({
+    x <- rjournal_article()
+  })
+})