add_manuscript: Add Rmarkdown manuscript

Description Usage Arguments Value Examples

View source: R/worcs_project.R

Description

Adds an Rmarkdown manuscript to a 'worcs' project.

Usage

1
2
3
4
5
6
7
add_manuscript(
  worcs_directory = ".",
  manuscript = "APA6",
  remote_repo = NULL,
  verbose = TRUE,
  ...
)

Arguments

worcs_directory

Character, indicating the directory in which to create the manuscript files. Default: '.', which points to the current working directory.

manuscript

Character, indicating what template to use for the 'R Markdown' manuscript. Default: 'APA6'. Available choices include: "APA6", "github_document", "None", "ams_article", "asa_article", "biometrics_article", "copernicus_article", "ctex", "elsevier_article", "frontiers_article", "ieee_article", "joss_article", "jss_article", "mdpi_article", "mnras_article", "oup_article", "peerj_article", "plos_article", "pnas_article", "rjournal_article", "rsos_article", "sage_article", "sim_article", "springer_article", "tf_article". For more information about APA6, see the 'papaja' package, at <https://github.com/crsh/papaja>. For more information about github_document, see github_document. The remaining formats are documented in the 'rticles' package.

remote_repo

Character, 'https' link to the remote repository for this project. This link should have the form https://[...].git. This link will be inserted in the draft manuscript.

verbose

Logical. Whether or not to print messages to the console during project creation. Default: TRUE

...

Additional arguments passed to and from functions.

Value

No return value. This function is called for its side effects.

Examples

1
2
3
4
5
6
7
8
the_test <- "worcs_manuscript"
old_wd <- getwd()
dir.create(file.path(tempdir(), the_test))
file.create(file.path(tempdir(), the_test, ".worcs"))
add_manuscript(file.path(tempdir(), the_test),
              manuscript = "github_document")
setwd(old_wd)
unlink(file.path(tempdir(), the_test))

worcs documentation built on Feb. 2, 2021, 5:13 p.m.