jameslairdsmith / customiser

customiser

customiser is an R Markdown output format that makes it easy for you to customise your R experience. It does this by handling the writing of your .Rprofile file. You, as a user, are able to gather and annotate the R code that you would like to run when your R session starts and customiser will send it to the appropriate place for R to read it at start-up.

Installation

You can install the released version of customiser from CRAN with:

install.packages("customiser")

And the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("jameslairdsmith/customiser")

Getting started

Once you've downloaded the package, the best place to get started is in RStudio. The package comes with a template that you can open by going to: File > New File > R Markdown > From Template and then choose 'customiser'. The file will start something like this:

---
title: "My .Rprofile"
knit: customiser::customiser
---

This is a template file you can use to customise your R experience with 
the customiser package. The code that you include here will be transferred to
your .Rprofile when you 'knit'.

Inspiration

If you want to learn more about customising your R experience, you can watch this webinar.

The following people have made their .Rprofile files public:

• Me
• Jim Hester

Other ideas:

• Athanasia Mo Mowinckel has written about how to customise R's startup messages.

customiser's Issues

Need to allow the dots

Separate chunk type for snippets

Release customiser 0.1.0

First release:

• usethis::use_news_md()
• usethis::use_cran_comments()
• Update (aspirational) install instructions in README
• Proofread Title: and Description:
• Check that all exported functions have @return and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• git pull
• usethis::use_github_links()
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• git push
• Draft blog post

Submit to CRAN:

• usethis::use_version('minor')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• Finish & publish blog post
• Add link to blog post in pkgdown news menu
• usethis::use_github_release()
• usethis::use_dev_version(push = TRUE)
• usethis::use_news_md()
• Tweet

Release customiser 0.1.1

Prepare for release:

• git pull
• Check current CRAN check results
• Polish NEWS
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• revdepcheck::revdep_check(num_workers = 4)
• Update cran-comments.md
• git push

Submit to CRAN:

• usethis::use_version('patch')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• usethis::use_github_release()
• usethis::use_dev_version(push = TRUE)