The goal of PPackage is to provide a personal R package of handy functions and small data sets that can be available to any project I’m working on.
You can install the development version of PPackage from GitHub with:
# install.packages("devtools")
devtools::install_github("JasonLocklin/PPackage", force=TRUE)
#> Downloading GitHub repo JasonLocklin/PPackage@HEAD
#> ── R CMD build ─────────────────────────────────────────────────────────────────
#> checking for file ‘/private/var/folders/_f/mnsldm313pl88dzjpc5kz3tr0000gq/T/RtmpLZNYxV/remotes4da7f2adb64/JasonLocklin-PPackage-c50eef6/DESCRIPTION’ ... ✔ checking for file ‘/private/var/folders/_f/mnsldm313pl88dzjpc5kz3tr0000gq/T/RtmpLZNYxV/remotes4da7f2adb64/JasonLocklin-PPackage-c50eef6/DESCRIPTION’
#> ─ preparing ‘PPackage’:
#> checking DESCRIPTION meta-information ... ✔ checking DESCRIPTION meta-information
#> ─ checking for LF line-endings in source and make files and shell scripts
#> ─ checking for empty or unneeded directories
#> ─ building ‘PPackage_0.0.0.9000.tar.gz’
#>
#>
Full documentation website on: https://JasonLocklin.github.io/PPackage
Full documentation website on: https://JasonLocklin.github.io/PPackage
This is a basic example which shows you how to solve a common problem:
library(PPackage)
## basic example code
What is special about using README.Rmd
instead of just README.md
?
You can include R chunks like so:
#head(schools)
You’ll still need to render README.Rmd
regularly, to keep README.md
up-to-date. devtools::build_readme()
is handy for this.
You can also embed plots, for example:
In that case, don’t forget to commit and push the resulting figure files, so they display on GitHub and CRAN.