From 6a4732ee1a87e4eed304c96719c156622888528e Mon Sep 17 00:00:00 2001 From: Tom Cardoso Date: Wed, 17 Feb 2021 14:19:32 -0500 Subject: [PATCH] updates readme and config --- README.md | 4 ++++ config.R | 7 +++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c7f10a5..a7d525a 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/config.R b/config.R index 0dc602f..98d99e5 100644 --- a/config.R +++ b/config.R @@ -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'