A template utility for R projects that provides a skeletal project.
R CSS HTML Other
Latest commit 934523f Jan 13, 2017 @Hugovdberg Hugovdberg committed with KentonWhite Ignore files in data directory (#178)
* Implemented regular expressions to ignore files in data directory, updated documentation

* Added data_ignore to the list of non-boolean variables

* Added test cases for ignoring data, updated documentation

* cleaned up tests: relined comments, uniform whitespace, replaced rm() with clear(), testing for cache ignored
Added data_ignore to project.config

* Updated documentation with note about cached data, disabled caching in the tests

* Updated test, expected error was not universal, rebuilt documentation as well

* This revert the changes to test-load.R

* Cleaned up debug messages; removed markdown from documentation

* Removed defaults for data_ignore, updated documentation

* Updated tests for changed default settings

README.markdown

ProjectTemplate Travis-CI build status

The ProjectTemplate package lets you automatically build a directory for a new R project with a standardized subdirectory structure. Using this structure, ProjectTemplate automates data and package loading. The hope is that standardized data loading, automatic importing of best practice packages, integrated unit testing and useful nudges towards keeping a cleanly organized codebase will improve the quality of R coding.

The inspiration comes from the rails command from Ruby on Rails, which initializes a new Rails project with the proper skeletal structure automatically. Also, ProjectTemplate follows Rails's approach of preferring convention over configuration: the automatic data and library loading as well as the automatic testing work easily because assumptions are made about the directory structure and naming conventions used in your code. You can customize your codebase however you'd like, but you will have to edit the ProjectTemplate loading functions to use your conventions instead of the defaults.

Installing

ProjectTemplate is now available on CRAN and can be installed using a simple call to install.packages():

install.packages('ProjectTemplate')

If you would like access to changes to this package that are not available in the version currently on CRAN, please install this package directly from Github,

    library('devtools')
    install_github('ProjectTemplate', username = 'johnmyleswhite')

For most users, running the bleeding edge version of this package is probably a mistake.

Example Code

To create a project called my-project, open R and type:

library('ProjectTemplate')
create.project('my-project')
setwd('my-project')
load.project()

Finding Out More