libminer/README.Rmd at main · MMMcMahon/libminer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
---
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/MMMcMahon/libminer/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/MMMcMahon/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("MMMcMahon/libminer")
```

## Example usage

To get a count of installed packages in each of your library locations, use the `lib_summary()` function:

```{r example}
library(libminer)
lib_summary()
```
you can also run lib() to list all of your packages:
```{r eval=FALSE}
lib()
```