Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 1.83 KB

README.md

File metadata and controls

69 lines (51 loc) · 1.83 KB

libminer

The goal of libminer is to …

Installation

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

# install.packages("devtools")
devtools::install_github("MatthewDettman/libminer")

Example

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

library(libminer)
## basic example code

lib_summary()
#>                                                                 Library
#> 1              C:/Users/Matt D/AppData/Local/Programs/R/R-4.3.1/library
#> 2 C:/Users/Matt D/AppData/Local/Temp/RtmpMVZOvu/temp_libpath6e45ca33c84
#>   n_packages
#> 1        488
#> 2          1

# Also can calculate sizes
lib_summary(sizes = TRUE)
#>                                                                 Library
#> 1              C:/Users/Matt D/AppData/Local/Programs/R/R-4.3.1/library
#> 2 C:/Users/Matt D/AppData/Local/Temp/RtmpMVZOvu/temp_libpath6e45ca33c84
#>   n_packages   lib_size
#> 1        488 1471825582
#> 2          1      12915

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 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.