R/rjournal_article.R

In rjtools: Preparing, Checking, and Submitting Articles to the 'R Journal'

#' Create an R Journal article with the existing template
#'
#' @details
#' Outputs an R Journal paper template set of files in the directory specified
#' by `dir_path` or in the project directory, if nothing is specified.
#' See \code{vignette("create_article", package = "rjtools")} for more details
#' on how to create and format an article.
#'
#' @param name the name of the Rmd, will default to "test"
#' @inheritParams rmarkdown::draft
#'
#' @importFrom stringr str_extract
#' @importFrom fs dir_create file_copy file_move
#' @export
create_article <- function(name="test", file = xfun::with_ext(name, "Rmd"), create_dir = FALSE, edit = TRUE){
  rmarkdown::draft(
    file,
    template = "rjournal",
    package = "rjtools",
    create_dir = create_dir,
    edit = FALSE
  )

  if(edit) {
    path <- if(create_dir) {
      file.path(xfun::sans_ext(file), file)
    } else {
      file
    }
    path <- normalizePath(path)
    has_rstudio <- if(requireNamespace("rstudioapi", quietly = TRUE)) {
      rstudioapi::hasFun("navigateToFile")
    } else {
      FALSE
    }
    if(has_rstudio) {
      rstudioapi::navigateToFile(path)
    } else {
      utils::file.edit(path)
    }
  }

  fs::dir_create("data")
  fs::dir_create("figures")
  fs::file_move("penguins.png", "figures/penguins.png")
  fs::dir_create("scripts")
  fs::dir_create("motivation-letter")
  fs::file_move("motivation-letter.md",
                "motivation-letter/motivation-letter.md")

  cli::cli_alert_info(
  "Please use the folder {.file data/}, {.file figures/}, {.file scripts/} and
  {.file motivation-letter/} to organise additional data, figures, scripts,
  and motivation letter.")
  cli::cli_alert_warning(
  "Please maintain the default file/folder structure as it will be checked
  upon submission.")
  cli::cli_alert_info(
  "[Action required] Please align the file name between {.file test.Rmd} and
  {.file RJreferences.bib}.")
  cli::cli_inform("Success: your paper is ready to edit!")
}