Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
images
javascripts
stylesheets
404.html
README.html
TODO.html
architecture.html
architecture.markdown
caching.jpg
changes.html
changes.markdown
configuring.html
configuring.markdown
contributing.html
contributing.markdown
create_letters_data_set.rb
directories.jpg
file_formats.html
file_formats.markdown
generate_website.rb
getting_started.html
getting_started.markdown
head.jpg
index.html
index.markdown
installing.html
installing.markdown
layout.erb
letters.csv.bz2
loading.jpg
logging.jpg
logo.jpg
mailing_list.html
mailing_list.markdown
mastering.html
mastering.markdown
mastering1.jpg
mastering2.jpg
mastering3.jpg
mastering4.jpg
mastering5.jpg
mastering6.jpg
mastering7.jpg
munging.jpg
munging_off.jpg
packages.html
packages.markdown
philapd.db.zip
plot1.png
plot2.png
unit_tests.jpg
updating.html
updating.markdown

README.html

<!doctype html>
<!--[if lt IE 7 ]><html class="ie ie6" lang="en"> <![endif]-->
<!--[if IE 7 ]><html class="ie ie7" lang="en"> <![endif]-->
<!--[if IE 8 ]><html class="ie ie8" lang="en"> <![endif]-->
<!--[if (gte IE 9)|!(IE)]><!--><html lang="en"> <!--<![endif]-->
<head>

	<!-- Basic Page Needs
  ================================================== -->
	<meta charset="utf-8" />
	<title>ProjectTemplate</title>
	<meta name="description" content="">
	<meta name="author" content="">
	<!--[if lt IE 9]>
		<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	
	<!-- Mobile Specific Metas
  ================================================== -->
	<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1" /> 
	
	<!-- CSS
  ================================================== -->
	<link rel="stylesheet" href="stylesheets/base.css">
	<link rel="stylesheet" href="stylesheets/skeleton.css">
	<link rel="stylesheet" href="stylesheets/layout.css">
	<link rel="stylesheet" href="stylesheets/docs.css">
	
	<!-- Favicons
	================================================== -->
	<link rel="shortcut icon" href="images/favicon.ico">
	<link rel="apple-touch-icon" href="images/apple-touch-icon.png">
	<link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png" />
	<link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png" />
	
</head>
<body>





	<!-- Primary Page Layout
	================================================== -->
	
	<!-- Delete everything in this .container and get started on your own site! -->

	<div class="container">	
	  <div class="sixteen columns">
  	  <a title="ProjectTemplate" label="ProjectTemplate" href="index.html"><img src="logo.jpg" height="75" width="405" /></a>
  	  <hr />
  	</div>

      <div class="four columns sidebar">
        <nav>
  	<ul>
  	  <li><a title="intro" href="./index.html">Introduction</a></li>
      <li><a title="installing" href="./installing.html">Installing</a></li>
      <li><a title="getting_started" href="./getting_started.html">Getting Started</a></li>
      <li><a title="mastering" href="./mastering.html">Mastering ProjectTemplate</a></li>
      <li><a title="configuring" href="./configuring.html">Configuring</a></li>
      <li><a title="updating" href="./updating.html">Updating</a></li>
      <li><a title="architecture" href="./architecture.html">Architecture</a></li>
      <li><a title="file_formats" href="./file_formats.html">Supported File Formats</a></li>
      <li><a title="changes" href="./changes.html">Changes</a></li>
      <li><a title="mailing_list" href="./mailing_list.html">Mailing List</a></li>
      <li><a title="contributing" href="./contributing.html">Contributing</a></li>
      <li><a title="packages" href="./packages.html">Building Packages</a></li>
      <li><a title="github" href="https://github.com/johnmyleswhite/ProjectTemplate">ProjectTemplate on GitHub</a></li>
      <!--<li><a title="README" href="./README.html">README</a></li>-->
      <!--<li><a title="TODO" href="./TODO.html">TODO</a></li>-->
  	</ul>
  	</nav>
      </div>


    <div class="eleven columns content offset-by-one">
      <h1>Introduction</h1>

<p>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.</p>

<p>The inspiration comes from the <code>rails</code> 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.</p>

<h1>Installing</h1>

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

<pre><code>install.packages('ProjectTemplate')
</code></pre>

<p>If you would like access to changes to this package that are not available in the version currently on CRAN, please download the contents of this repository and then run,</p>

<pre><code>R CMD INSTALL ProjectTemplate_*.tar.gz
</code></pre>

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

<h1>Example Code</h1>

<p>To create a project called <code>my-project</code>, open R and type:</p>

<pre><code>library('ProjectTemplate')
create.project('my-project')
setwd('my-project')
load.project()
</code></pre>

<h1>Finding Out More</h1>

<ul>
<li>Website: Visit the <a href="http://projecttemplate.net">ProjectTemplate website</a> for more details.</li>
<li>Mailing List: ProjectTemplate has a Google Group, which can be found at <a href="http://groups.google.com/group/projecttemplate">http://groups.google.com/group/projecttemplate</a></li>
<li>Twitter: Updates to ProjectTemplate are announced on Twitter using the hashtag #ProjectTemplate.</li>
</ul>

    </div>
    
    <div class="sixteen columns">
      <hr />
      <footer>
      Styled with <a href="http://www.getskeleton.com/">skeleton</a>. Design ideas taken from the <a href="http://plyr.had.co.nz/">plyr</a> and <a href="http://www.rapache.net/">rApache</a> websites.
      </footer>
    </div>
    
	</div>
	<!-- container -->

	<!-- JS
	================================================== -->
	<script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script>
	<script>window.jQuery || document.write("<script src='javascripts/jquery-1.5.1.min.js'>\x3C/script>")</script>
	<script src="javascripts/app.js"></script>
	
<!-- End Document
================================================== -->
</body>
</html>
Something went wrong with that request. Please try again.