forked from open-AIMS/toxval
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
56 lines (43 loc) · 1.7 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
stopifnot(require(knitr))
options(width = 90)
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%"
)
```
```{r, echo = FALSE}
version <- as.vector(read.dcf("DESCRIPTION")[, "Version"])
version <- gsub("-", ".", version)
```
[](https://choosealicense.com/)
[](https://github.com/open-AIMS/toxval/issues/new)
[](https://zenodo.org/doi/10.5281/zenodo.12753573)
<!-- badges: end -->
## Overview
`toxval` package extracts NSEC or ECx estimates from supported fitted frequentest (drc) and Bayesian (bayesnec) model objects. For more details see [Fisher & Fox (2023)](https://doi.org/10.1002/etc.5610).
## Installation
The current development version can be downloaded from GitHub via
```{r eval=FALSE}
if (!requireNamespace("remotes")) {
install.packages("remotes")
}
remotes::install_github("open-aims/toxval", ref = "main")
```
## Usage
Usage and further information about `toxval` can be seen on the [project
page](https://open-aims.github.io/toxval/) and the
[reference page](https://open-aims.github.io/toxval/reference/).
## Further Information
`toxval` is provided by the
[Australian Institute of Marine Science](https://www.aims.gov.au) under the
GPL-2 License ([GPL-2](https://opensource.org/license/gpl-2-0/)).