Skip to content

Commit

Permalink
Updated readme with new style
Browse files Browse the repository at this point in the history
  • Loading branch information
lwjohnst86 committed Jul 29, 2016
1 parent 4112125 commit 6941086
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
This is a *pro*ject *di*rectory *gen*erato*r* (`prodigenr`) that will
create a project directory structure with template files necessary for
managing and analyzing data for a variety of projects. This allows
for a standardized approach to having a modular research project.
for a standardized approach to having a modular research project, while also
taking advantage of existing well-developed and maintained infrastructures and
processes (Rstudio and devtools).

# How to install

Expand All @@ -22,15 +24,15 @@ The main function is the `prodigen` command. So, for instance, if you
want a manuscript project, type out:

library(prodigenr)
prodigen(proj.name = 'cancerAndToxins',
proj.type = 'manuscript', proj.path = '/path/to/new/project')
prodigen(type = 'manuscript', name = 'cancerToxins',
path = '/path/to/new/project')

This then creates a directory tree, with template files for starting
your analysis! The main secondary function is the `list_templates`
your analysis! The main secondary function is the `template_list`
command, which lists the available template projects and files (submit
a PR if you want another template included!):

list_templates('projects') ## Shows project templates
template_list

For a more detailed tutorial, see the vignette:

Expand Down

0 comments on commit 6941086

Please sign in to comment.