CTutilsproject: CTutilsproject

Description Usage Arguments Value Examples

View source: R/CTutilsproject.R

Description

Create a directory structure to match that used by CTutils (PHS). This function is meant to be used within RStudio by going to the File menu, then New Project.

Usage

1
2
3
4
5
6
7
8
9
CTutilsproject(
  path,
  author_name = "Lisa Hopcroft",
  author_email = "Lisa.Hopcroft@phs.scot",
  author_organisation = "Public Health Scotland",
  trial_name = "TRIAL_NAME",
  git = TRUE,
  renv = FALSE
)

Arguments

path

Filepath for the project

author_name

Name of the main author for the project

author_email

Email of the main author for the project

author_organisation

Organisation of the main author for the project

trial_name

Short name of the trial (e.g., NAXIVA, SPRING)

git

Initialise the project with Git

renv

Initialise the project with package management using renv

Value

New project created according to the CTutils project structure.

Examples

1
2
3
4
## Not run: 
phsproject(path = file.path(getwd(), "testproj"), author_name = "A Person")

## End(Not run)

LisaHopcroft/CTutils documentation built on Oct. 7, 2021, 11:08 p.m.