README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# libminer

<!-- badges: start -->
<!-- badges: end -->

The goal of libminer is to provide an overview of your R library setup. It is
a toy package created as a part of a workshop in package development.

## Installation

You can install the development version of libminer from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("lmaowisc/libminer")
```

## Example

To get a count of installed packages in each of your library, optionally
with the total sizes, use `lib_summary()`

```{r example}
library(libminer)
## basic example code
lib_summary()
## add sizes
lib_summary(sizes = TRUE)
```