create_project: Setup directory and templates for a new research study

View source: R/create_project.R

create_projectR Documentation

Setup directory and templates for a new research study

Description

This function can be used to automatically setup your study directory by creating folders and template scripts

Usage

create_project(
  script_templates = FALSE,
  main_script = FALSE,
  raw_script = FALSE,
  score_script = FALSE,
  merge_script = FALSE,
  analysis_script = FALSE,
  data_raw = FALSE,
  data_scored = FALSE,
  analyses = FALSE,
  documents = FALSE,
  tasks = FALSE,
  manuscript = FALSE,
  presentations = FALSE,
  other = c(),
  standard_project = FALSE,
  path = "."
)

Arguments

script_templates

Logical. Download all script templates? default = FALSE

main_script

Logical. Download a main script template? default = TRUE

raw_script

Logical. Download a raw script template? default = FALSE

score_script

Logical. Download a score script template? default = FALSE

merge_script

Logical. Download a merge script template? default = FALSE

analysis_script

Logical. Download template to do data analysis (.Rmd)? default = FALSE

data_raw

Logical. Create a raw data directory? default = FALSE

data_scored

Logical. Create a scored data directory? default = FALSE

analyses

Logical. Create an analyses directory? default = FALSE

documents

Logical. Create documents directory? default = FALSE

tasks

Logical. Create tasks directory? default = FALSE

manuscript

Logical. Create manuscript directory? default = FALSE

presentations

Logical. Create presentations directory? default = FALSE

other

List of other directories you want to create

standard_project

Logical. Create a standard project directory? default = FALSE

path

String. Home directory file path


dr-JT/workflow documentation built on March 19, 2024, 7:51 p.m.