-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
77 lines (51 loc) · 3.28 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
---
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%"
)
```
# biometryassist
```{r, echo = FALSE}
description <- read.dcf('DESCRIPTION')
version <- as.vector(description[, 'Version'])
min.r <- substr(description[,"Depends"], 7, 11)
```
<!-- badges: start -->
[![Project Status: Active: The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Codecov test coverage](https://codecov.io/gh/biometryhub/biometryassist/branch/main/graph/badge.svg)](https://app.codecov.io/gh/biometryhub/biometryassist?branch=main)
[![R build status](https://github.com/biometryhub/biometryassist/workflows/R-CMD-check/badge.svg)](https://github.com/biometryhub/biometryassist/actions)
[![minimal R version](https://img.shields.io/badge/R%3E%3D-`r min.r`-6666ff.svg)](https://cran.r-project.org/)
[![packageversion](https://img.shields.io/badge/Package%20version-`r gsub('-', '--', version)`-orange.svg?style=flat-square)](https://github.com/biometryhub/biometryassist/commits/main)
[![Licence](https://img.shields.io/github/license/mashape/apistatus.svg)](https://choosealicense.com/licenses/mit/)
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgit.luolix.top%2Fbiometryhub%2Fbiometryassist&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
<!-- badges: end -->
The goal of biometryassist is to provide functions to aid in the Design and Analysis of Agronomic-style experiments through easy access to documentation and helper functions, especially while teaching these concepts.
*This package is a renamed version of BiometryTraining which is no longer maintained, but can still be found at https://biometryhub.github.io/BiometryTraining/*
----
## Installation
As of version 1.0.0 the biometryassist package is now [on CRAN](https://cran.r-project.org/package=biometryassist) 🙌
That means that installation is as easy as running:
```{r installing_cran, eval=FALSE}
install.packages("biometryassist")
```
### Development version
⚠ **Warning**: The development version is unstable and liable to change more often than the CRAN version. It may have bugs fixed, but there may be other currently unknown bugs introduced. ⚠
Use the following code to install the latest development version of this package.
```{r eval=F}
if(!require("remotes")) install.packages("remotes")
remotes::install_github("biometryhub/biometryassist@dev")
```
## Using the package
Load the package and start using it with:
```{r eval=F}
library(biometryassist)
```
If you find this package useful, please cite it! Type `citation("biometryassist")` on the R console to find out how.
## Troubleshooting Installation
- If you receive an error that the package could not install because `rlang` or another package could not be upgraded, the easiest way to deal with this is to uninstall the package(s) that could not be updated (`remove.packages("rlang")`). Then restart R, re-install with `install.packages("rlang")` and then try installing `biometryassist` again.