Skip to content

Commit

Permalink
updates readme and config
Browse files Browse the repository at this point in the history
  • Loading branch information
tomcardoso committed Feb 17, 2021
1 parent e92a02e commit 6a4732e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ Broadly, `startr` does a few things:

This template works with R and RStudio, so you'll need both of those installed. To scaffold a new `startr` project, we recommend using our command-line tool, [`startr-cli`](https://github.com/globeandmail/startr-cli), which will copy down the folder structure, rename some files, configure the project and initialize an empty Git repository.

Using [`startr-cli`](https://github.com/globeandmail/startr-cli), you can scaffold a new project by simply running `create-startr` in your terminal and following the prompts:

![startr-cli interface GIF](http://i.imgur.com/4qtiJar.gif)

Alternatively, you can run:
```sh
git clone https://github.com/globeandmail/startr.git <your-project-name-here>
Expand Down
7 changes: 5 additions & 2 deletions config.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,8 @@ initialize_startr(
)
)

# Refer to your source data filenames here
sample.raw.file <- dir_data_raw('your-filename-here.csv')
# Refer to your source data filenames here. These can be either references
# to files in your `data/raw` folder, or paths to files hosted on the web.
# For example:
# sample.raw.file <- dir_data_raw('your-filename-here.csv')
# sample.raw.path <- 'https://github.com/tidyverse/dplyr/raw/master/data-raw/starwars.csv'

0 comments on commit 6a4732e

Please sign in to comment.