new_project: Create new project

In renlund/proh: pro(ject) h(enrik style)

Create new project

Description

This function sets up a project directory structure along with some files

Usage

new_project(
  name = "new_project",
  path = NULL,
  class = "ucr",
  dm = TRUE,
  RSproj = TRUE,
  git = TRUE,
  checkpoint = TRUE,
  checkpoint.date = NULL,
  go_there = FALSE,
  org = FALSE
)

Arguments

name	Name of the project
path	Path to project directory (else current)
class	Class of document in 'rapport.rnw' (default: 'ucr')
dm	should a data management file be created? (default: TRUE)
RSproj	Start a RStudio project? (deault: TRUE)
git	should git be initialized? (also a .gitignore file will be created)
checkpoint	should checkpoint be used?
checkpoint.date	date for checkpoint
go_there	Set working directory to project directory? (default: FALSE)
org	should an org file be created?

Details

This function sets up a folder with subfolders

• cache: this is only used by knitr

• calc: this is for storage of .rdat files

• calc/autoload: this is for storage of inline values. Typically this folder will automatically be loaded in a first (uncached) chunk of the report file by fetch_all.

• figure: for plots (also used by knitr)

• recieved: typically this is were I put files given by clients

• sent: this is were I store things sent to client. The function send will attach the current date to the pdf version of the report and put it in this directory. Optionally, send can zip the report along with the graphs and tables from their respective directory

• table: for (human readable) tabulated data

and creates, optionally, the files

• 'rapport.rnw': the report file, can be changed to suit your needs, but is designed to have a first uncached chunk (by default called 'autoLoad') that executes fetch_all()

• .Rprofile which will load and point proh to the source file

• 'references.bib': a template for bibTeX references

• a .rsproj file with the project name: this is an RStudio project file, by starting this file RStudio will set the working directory and remember what documents you were looking at. There are settings to be made that can be project specific

• .gitignore: a file that git uses to tell which files to ignore

Author(s)

Henrik Renlund

renlund/proh documentation built on March 25, 2023, 10:07 a.m.