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 -->
[![R-CMD-check](https://github.com/ateucher/libminer/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ateucher/libminer/actions/workflows/R-CMD-check.yaml)
<!-- 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 and not meant for serious use.

## Installation

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

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

## Example usage


To get a nicely formatted tibble of your installed packages, use the `lib()`
function:

```{r}
library(libminer)
lib()
```


To get a count of installed packages, grouped by any combination of variables
in the `lib()` data.frame, optionally with the total sizes, use the `lib_summary()` function:

```{r example}
lib_summary(LibPath, License)
```

Specify `sizes = TRUE` to calculate the total size on disk of your packages

```{r}
lib_summary(LibPath, NeedsCompilation, sizes = TRUE)
```