CreateStudyTemplate: Create study template

In martingerdin/bengaltiger: bengaltiger

Description

Creates a .R file with a custom name where all study steps are documented and run.

Usage

CreateStudyTemplate(study.name = "My bengaltiger study",
  authors = "Firstname Lastname",
  description = "This is a bengaltiger study.", file.name = "RunStudy",
  path = ".", create.directory = FALSE,
  functions.to.include = c("ImportStudyData"), save.as.function = TRUE,
  function.name = file.name, open = TRUE)

Arguments

study.name	Character vector of length 1. The name of the study. Defaults to "My bengaltiger study".
authors	Character vector. The names of the study authors. Defaults to c("Firstname Lastname").
description	Character vector of length 1. Short description of the study. Defaults to "This is a bengaltiger study.".
file.name	Character vector of length 1. The file name. Defaults to "RunStudy".
path	Character vector of length 1. The path where the study template is saved. Defaults to ".", i.e. the current working directory.
create.directory	Logical vector of length 1. If TRUE the directory to which path is pointing is created using dir.create(path) if it does not already exist. Defaults to FALSE.
functions.to.include	Character vector. The names of the functions to include in the template. Defaults to c("ImportsStudyData").
save.as.function	Logical vector of length 1. If TRUE the study template is structured as a R function. Defaults to TRUE.
function.name	Character vector of length 1. The name of the study function. Is used only if as.functions = TRUE. Defaults to file.name.
open	Logical vector of length 1. If TRUE the study template file is opened using R's file.edit(). Defaults to TRUE.

martingerdin/bengaltiger documentation built on Feb. 29, 2020, 4:46 p.m.