-
Notifications
You must be signed in to change notification settings - Fork 5
/
README.Rmd
91 lines (68 loc) · 3.35 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
87
88
89
90
91
---
title: "README-BioMonTools"
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()))
```
# BioMonTools <img src="man/figures/logo.png" align="right" height="139" />
Functions to aid the data analysis of bioassessment and biomonitoring data.
Suite of functions and tools for metric calculation and scoring for mult-metric
indices and related data manipulation.
<!-- badges: start -->
# Badges
[](https://GitHub.com/leppott/BioMonTools/graphs/commit-activity)
[](https://www.tidyverse.org/lifecycle/#stable)
[](https://github.com/leppott/BioMonTools/blob/master/LICENSE)
[](https://www.codefactor.io/repository/github/leppott/BioMonTools)
[](https://codecov.io/gh/leppott/BioMonTools)
[](https://github.com/leppott/BioMonTools/actions/workflows/R-CMD-check.yaml)
[](https://GitHub.com/leppott/BioMonTools/issues/)
[](https://GitHub.com/leppott/BioMonTools/releases/)
[](https://GitHub.com/leppott/BioMonTools/releases/)
<!-- badges: end -->
# Installation
To install the current version 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.
```{r, eval=FALSE}
if(!require(remotes)){install.packages("remotes")} #install if needed
install_github("leppott/BioMonTools", force=TRUE)
```
Vignettes are not installed by default. If you want the additional
documentation (recommended) then use this version of the code.
```{r, eval=FALSE}
if(!require(remotes)){install.packages("remotes")} #install if needed
install_github("leppott/BioMonTools", force=TRUE, build_vignettes=TRUE)
```
If having issues with install (e.g., 'cannot open URL') it could be a latency
issue with GitHub.
Use the code below before retrying the above install commands.
```{r, eval=FALSE}
options(timeout=400)
```
# Status
In development.
# Usage
By those using involved with bioassessment and biomonitoring and the need for data manipulation.
A common set of tools will standardize outputs across entities. No longer need to use
the same database or spreadsheet. Only need to format data for use with these tools.
# Documentation
Vignette and install guide updates are planned for the future.
# Issues
https://github.com/leppott/BioMonTools/issues
# Planned Updates
* None at this time.
# Future Possible Updates
* Periphyton metrics.
* Coral and Fish metrics (Puerto Rico and US Virgin Islands)
* TaxaList Check
* Map taxon observations