-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
63 lines (50 loc) · 2.44 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
---
title: "README-MBSStools"
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
```{r, echo = FALSE}
cat(paste0("Last Update: ",Sys.time()))
```
Suite of tools for data manipulation and calculations for Maryland DNR MBSS program.
Badges
-----------
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/leppott/MBSStools/graphs/commit-activity)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![License: GPL (>= 3)](https://img.shields.io/badge/license-GPL (>= 3)-blue.svg)](https://cran.r-project.org/web/licenses/GPL (>= 3))
[![CodeFactor](https://www.codefactor.io/repository/github/leppott/MBSStools/badge)](https://www.codefactor.io/repository/github/leppott/MBSStools)
[![codecov](https://codecov.io/gh/leppott/MBSStools/branch/master/graph/badge.svg)](https://codecov.io/gh/leppott/MBSStools)
[![R-CMD-check](https://github.com/leppott/MBSStools/workflows/R-CMD-check/badge.svg)](https://github.com/leppott/MBSStools/actions)
[![GitHub issues](https://img.shields.io/github/issues/leppott/MBSStools.svg)](https://GitHub.com/leppott/MBSStools/issues/)
[![GitHub release](https://img.shields.io/github/release/leppott/MBSStools.svg)](https://GitHub.com/leppott/MBSStools/releases/)
[![Github all releases](https://img.shields.io/github/downloads/leppott/MBSStools/total.svg)](https://GitHub.com/leppott/MBSStools/releases/)
Installation
------------
To install the current version of this package use the code below to install
from GitHub. The use of “force = TRUE” ensures the package is installed even if
already present. If the package `remotes` is missing the code below will install
it. Vigenettes are not insalled by default. The use of
"build_vignettes = TRUE" will install the vignettes.
```{r, eval=FALSE}
if(!require(remotes)){install.packages("remotes")} #install if needed
install_github("leppott/MBSStools", force=TRUE, build_vignettes = TRUE)
```
Purpose
------------
To aid MBSS staff with calculations and data manipulations.
Status
------------
Stable. Minor updates planned in FY2021.
Usage
------------
By MBSS staff or those using MBSS data.
Documentation
------------
Included Vignette and install guide.