egpkg

The goal of egpkg is to …

Installation

You can install the development version of egpkg from GitHub with:

# install.packages("devtools")
devtools::install_github("UofUEpiBio/egpkg")

Example

This is a basic example which shows you how to solve a common problem:

library(egpkg)
## basic example code

What is special about using README.Rmd instead of just README.md? You can include R chunks like so:

summary(cars)
#>      speed           dist       
#>  Min.   : 4.0   Min.   :  2.00  
#>  1st Qu.:12.0   1st Qu.: 26.00  
#>  Median :15.0   Median : 36.00  
#>  Mean   :15.4   Mean   : 42.98  
#>  3rd Qu.:19.0   3rd Qu.: 56.00  
#>  Max.   :25.0   Max.   :120.00

You’ll still need to render README.Rmd regularly, to keep README.md up-to-date. devtools::build_readme() is handy for this. You could also use GitHub Actions to re-render README.Rmd every time you push. An example workflow can be found here: https://github.com/r-lib/actions/tree/v1/examples.

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.

Installing from source

You can install this package from the source using the following commands from the command line:

R CMD build .
R CMD INSTALL egpkg2024_1.0.tar.gz

The first command builds a tar.gz file that can be shared. This is what you share when you submit to CRAN. The second command installs the package in your computer. Notice that this approach builds the vignettes, making them available to your R session. Recall you can access vignettes using the vignette command like this:

vignette(package="dplyr")

Which will list the vignettes available to the dplyr R package (learn more typing ?vignette in your R console).