-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
quick readme so I remember how to use it and what it does.
- Loading branch information
Showing
5 changed files
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.Rproj.user | ||
.Rhistory | ||
.RData | ||
_DS_Store | ||
*.html |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
output: | ||
html_document: | ||
keep_md: TRUE | ||
variant: markdown_github | ||
--- | ||
|
||
dames stands for `d`ata n`ames`. Data names are file names with consistent formatting. Variables are consitently ordered and separated by a consistent separator. Variables are things like date (2015-08-28), abbreviation-or-accronym (AOA), slug-formatted-descriptor (slug-name-of-file-that-describes-its-contents), and file extension (ext). | ||
|
||
For example: | ||
``` | ||
AOA_01_slug-name-of-file-that-describes-its-contents.ext | ||
``` | ||
|
||
You set your working directory to clean project directory: | ||
```{r set-wd, eval = FALSE} | ||
setwd("path/to/my/project") | ||
``` | ||
![alt text](README-set-wd.png) | ||
|
||
then you can build up your project with `nd` | ||
```{r build-it-up, eval = FALSE} | ||
nd("first file") | ||
nd("another file") | ||
nd("third file with a different aoa",aoa = "DIFF") | ||
``` | ||
![alt text](README-build-it-up.png) | ||
|
||
Where the output of each op is an damed `.Rmd` file that contains a child link to the REF_template.Rmd (for common stuff) and a YAML header configured for keeping a github-flavoured markdown when knitting to html. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
|
||
dames stands for `d`ata n`ames`. Data names are file names with consistent formatting. Variables are consitently ordered and separated by a consistent separator. Variables are things like date (2015-08-28), abbreviation-or-accronym (AOA), slug-formatted-descriptor (slug-name-of-file-that-describes-its-contents), and file extension (ext). | ||
|
||
For example: | ||
``` | ||
AOA_01_slug-name-of-file-that-describes-its-contents.ext | ||
``` | ||
|
||
You set your working directory to clean project directory: | ||
|
||
```r | ||
setwd("path/to/my/project") | ||
``` | ||
![alt text](README-set-wd.png) | ||
|
||
then you can build up your project with `nd` | ||
|
||
```r | ||
nd("first file") | ||
nd("another file") | ||
nd("third file with a different aoa",aoa = "DIFF") | ||
``` | ||
![alt text](README-build-it-up.png) | ||
|
||
Where the output of each op is an damed `.Rmd` file that contains a child link to the REF_template.Rmd (for common stuff) and a YAML header configured for keeping a github-flavoured markdown when knitting to html. | ||
|