-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
82 lines (56 loc) · 3.72 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
---
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%"
)
```
# BiometryTraining
```{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/BiometryTraining/branch/master/graph/badge.svg)](https://app.codecov.io/gh/biometryhub/BiometryTraining?branch=master)
[![R build status](https://github.com/biometryhub/BiometryTraining/workflows/R-CMD-check/badge.svg)](https://github.com/biometryhub/BiometryTraining/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/BiometryTraining/commits/master)
[![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%2Fgithub.com%2Fbiometryhub%2FBiometryTraining&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
<!-- badges: end -->
## Final Release of BiometryTraining
**This package will no longer be developed, however this repository and the associated website will remain. All future development work will be undertaken in the [biometryassist package](https://biometryhub.github.io/biometryassist/).**
-----
The goal of BiometryTraining 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.
## Installation
Use the following code to install this package:
```{r eval=F}
if(!require("remotes")) install.packages("remotes")
remotes::install_github("biometryhub/BiometryTraining", upgrade = FALSE)
```
## Using the package
Load the package and start using it with:
```{r eval=F}
library(BiometryTraining)
```
If you find this pacakge useful, please cite it! Type `citation("BiometryTraining")` on the R console to find out how.
## Troubleshooting Installation
- If you have the latest version already installed, you will get a response like:
<span style="color: red;">Skipping install of 'BiometryTraining' from a github remote, the SHA1 (e034b603) has not changed since last install.<br>
Use `force = TRUE` to force installation</span>
- The following warning messages can usually be ignored:
<span style="color: red;">WARNING: Rtools is required to build R packages, but is not currently installed.</span>
<span style="color: red;">Please download and install Rtools custom from https://cran.r-project.org/bin/windows/Rtools/.</span>
<span style="color: red;">Warning messages:<br>
1: In untar2(tarfile, files, list, exdir) :<br>
skipping pax global extended headers<br>
2: In untar2(tarfile, files, list, exdir) :<br>
skipping pax global extended headers</span>
- 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 reinstall with `install.packages("rlang")` and then try installing `BiometryTraining` again.