-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
88 lines (55 loc) · 2.05 KB
/
README.Rmd
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
options(width = 100)
Sys.setlocale("LC_COLLATE", "en_US.UTF-8") # ensure common sorting envir
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
ver <- desc::desc_get_version(".")
ver <- paste0("https://img.shields.io/badge/Version-", ver,
"-success.svg?style=flat&logo=github")
```
# The `helpr` package
<!-- badges: start -->
![GitHub version](`r ver`)
[![CRAN status](http://www.r-pkg.org/badges/version/helpr)](https://cran.r-project.org/package=helpr)
[![R-CMD-check](https://github.com/stufield/helpr/workflows/R-CMD-check/badge.svg)](https://github.com/stufield/helpr/actions)
[![](https://cranlogs.r-pkg.org/badges/grand-total/helpr)](https://cran.r-project.org/package=helpr)
[![Codecov test coverage](https://codecov.io/gh/stufield/helpr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/stufield/helpr?branch=main)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://choosealicense.com/licenses/mit/)
<!-- badges: end -->
## Overview
The `helpr` package contains numerous helper functions
necessary for generalized machine learning analyses.
It contains and exports numerous utilities and S3 generics
used throughout the my personal analysis suite.
It intentionally favors base R over higher
level *tidyverse* to keep imports to a minimum.
----------------
## Installation
```{r install-github, eval = FALSE}
remotes::install_github("helpr")
# OR
remotes::install_version("helpr", "0.0.1")
```
----------------
## Usage
To load `helpr` simply make a call to `library()` as usual:
```{r load, eval = FALSE}
library(helpr)
```
## Help summary of the package
```{r help, eval = FALSE}
library(help = helpr)
```
## Notes about the package
* [ ] TODO
* [ ] TODO
* [ ] TODO