Skip to content

Commit

Permalink
makes tweaks to rproj
Browse files Browse the repository at this point in the history
  • Loading branch information
tomcardoso committed Apr 17, 2019
1 parent 9c9dd82 commit f72e088
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 14 deletions.
17 changes: 9 additions & 8 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
Package: startR
Type: Package
Title: What the Package Does (Title Case)
Version: 0.1.0
Author: Who wrote it
Maintainer: The package maintainer <yourself@somewhere.net>
Description: More about what it does (maybe more than one line)
Use four spaces when indenting paragraphs within the Description.
License: What license is it under?
Title: A Template For Data Journalism Projects In R
Version: 1.0.1
Author: Michael Pereira <mpereira@globeandmail.com> and Tom Cardoso <tcardoso@globeandmail.com>
Maintainer: Michael Pereira <mpereira@globeandmail.com> and Tom Cardoso <tcardoso@globeandmail.com>
Description: This project structures the data analysis process around an expected set of files and steps.
This lowers the upfront effort of starting and maintaining a project and supports easier verification by providing reviewers with an expected and logically organized project.
Think of it like Ruby on Rails or React, but for R analysis.
License: MIT
Encoding: UTF-8
LazyData: true
LazyData: true
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# startr

A template for data analysis projects in R.
A template for data journalism projects in R.

This project structures the data analysis process around an expected set of files and steps. This lowers the upfront effort of starting and maintaining a project and supports easier verification by providing reviewers with an expected and logically organized project. Think of it like Ruby on Rails or React, but for R analysis.

Expand Down Expand Up @@ -46,7 +46,7 @@ Packages are managed through the `packages` list in the `config.R` file. `devtoo

The bulk of the analysis is based on a set of files within the `R` directory which are sourced and run in order by `run.R` at the project root.

Before starting an analysis, you'll want to point to your data files in `config.R` and make sure it's loading all the packages you'll need. For instance, you might want to add the [`cancensus`](https://github.com/mountainMath/cancensus) package. To do that, just add `'cancensus'` to the `packages` vector. Package suggestions for GIS work, scraping, dataset summaries, etc. are included and commented out to avoid bloat.
Before starting an analysis, you'll want to point to your data files in `config.R` and make sure it's loading all the packages you'll need. For instance, you might want to add the [`cancensus`](https://github.com/mountainMath/cancensus) package. To do that, just add `'cancensus'` to the `packages` vector. Package suggestions for GIS work, scraping, dataset summaries, etc. are included and commented out to avoid bloat.

Once that's done, you'll want to reference your raw data filenames. For instance, if you're adding pizza delivery data, you'd add this line to the "Files" block in `config.R`:

Expand Down Expand Up @@ -155,7 +155,7 @@ An `.nvmrc` is included at the project root for scraping with Node. A `venv` and

## Version

1.0.0
1.0.1

## License

Expand Down
7 changes: 4 additions & 3 deletions startr.Rproj
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
Version: 1.0

RestoreWorkspace: Default
SaveWorkspace: Default
RestoreWorkspace: No
SaveWorkspace: No
AlwaysSaveHistory: Default
QuitChildProcessesOnExit: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
RnwWeave: knitr
LaTeX: pdfLaTeX

AutoAppendNewline: Yes
Expand Down

0 comments on commit f72e088

Please sign in to comment.