makeProject: Make Project LCFD Framework

Description Usage Arguments Value Author(s)

Description

This package was inspired by a stackoverflow.com comment made by Josh Reich. This package creates an empty framework of files and directories for the "Load, Clean, Func, Do" structure described by Josh. The concept is simple. The "main.R" script is called by the user. It sets global variables and calls all the other scipts necessary.

Usage

1
2
makeProject(name = "myProject", path = getwd(), force = FALSE, 
author = "Your Name", email = "yourfault@somewhere.net")

Arguments

name

The name of your project

path

The path of where to create the project framework. A directory with the name of the project will be created here.

force

Force creation of the project, even if files already exist

author

The author's name

email

The author's email

Value

This function will create:

Parent Directory

The parent project directory

main.R

This is where you set global variables, and call the other scripts.

data

An empty data directory to hold your data files.

code

A code directory containing the other code files.

load.R

This is where you insert code to load in libraries and data files.

clean.R

This is where you perform any messy data cleanup.

func.R

This is where you write all the functions that you need.

do.R

This is where the actual work is done.

Author(s)

Noah Silverman
Department of Statistics, UCLA
emailnoahsilverman@ucla.edu


makeProject documentation built on May 2, 2019, 10:21 a.m.