worcs (version 0.1.2)

worcs_project: Create new WORCS project

Description

Creates a new 'worcs' project. This function is invoked by the 'RStudio' project template manager, but can also be called directly to create a WORCS project through syntax or the console.

Usage

worcs_project(
  path = "worcs_project",
  manuscript = "APA6",
  preregistration = "COS",
  add_license = "CC_BY_4.0",
  use_renv = TRUE,
  remote_repo = "https",
  verbose = TRUE,
  ...
)

Arguments

path

Character, indicating the directory in which to create the 'worcs' project. Default: 'worcs_project'.

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.

preregistration

Character, indicating what template to use for the preregistration. Default: 'COS'. Available choices include: "COS", "VantVeer", "Brandt", "AsPredicted", "None". For more information, see, e.g., cos_prereg.

add_license

Character, indicating what license to include. Default: 'CC_BY_4.0'. Available options include: "CC_BY_4.0", "CC_BY-SA_4.0", "CC_BY-NC_4.0", "CC_BY-NC-SA_4.0", "CC_BY-ND_4.0", "CC_BY-NC-ND_4.0", "None". For more information, see <https://creativecommons.org/licenses/>.

use_renv

Logical, indicating whether or not to use 'renv' to make the project reproducible. Default: TRUE. See init.

remote_repo

Character, 'https' link to the remote repository for this project. This link should have the form https://[...].git. If a valid remote repository link is provided, a commit will be made containing the 'README.md' file, and will be pushed to the remote repository. Default: 'https'. When no 'https' address is provided, an 'SSH' address of the form git@[...].git is also accepted.

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

# NOT RUN {
the_test <- "worcs_template"
old_wd <- getwd()
dir.create(file.path(tempdir(), the_test))
do.call(git_user, worcs:::get_user())
worcs_project(file.path(tempdir(), the_test, "worcs_project"),
              manuscript = "github_document",
              preregistration = "None",
              add_license = "None",
              use_renv = FALSE,
              remote_repo = "https")
setwd(old_wd)
unlink(file.path(tempdir(), the_test))
# }