search

nutterb / pixiedust

Tables So Beautifully Fine-Tuned You Will Believe It's Magic.
180 stars 18 forks source link

Added a README.Rmd to compile to README.md, and a .Rproj file #10

Closed dgrtwo closed 9 years ago

dgrtwo commented 9 years ago

I've suggested adding a README.Rmd file, which compiles to README.md with knit("README.Rmd"). (See ?devtools::use_readme_rmd). This has two advantages:

  1. Code is compiled without >, which makes it a bit easier to copy/paste into a terminal.
  2. This keeps the README up to date with the package usage and output (for example, in this process I found the README uses dust_colnames, which appears to have been renamed sprinkle_colnames in the released version).

I also added a .Rproj file just so that developers can immediately clone and open the project, but it's up to you whether to use it.

Thanks for your awesome work on this package.

nutterb commented 9 years ago

Great suggestions. Thanks for taking the time to put this together.