-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME.Rmd
102 lines (62 loc) · 2.86 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
92
93
94
95
96
97
98
99
100
101
102
---
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/",
out.width = "100%"
)
```
samplesim <img src="man/figures/hexsticker.png" height="120" align="right"/>
=========================================================
<!-- badges: start -->
[](https://github.com/ahasverus/samplesim/actions/workflows/R-CMD-check.yaml)
[](https://github.com/ahasverus/samplesim/actions/workflows/pkgdown.yaml)
[](https://choosealicense.com/licenses/gpl-2.0/)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://www.repostatus.org/#active)
<!-- badges: end -->
The goal of the R package `samplesim` is to estimate sample size effects in
stable isotope mixing solutions.
## System requierements
The package `samplesim` requires the freeware
[JAGS](https://mcmc-jags.sourceforge.io/).
## Installation
You can install the stable version of `samplesim` with:
```{r eval = FALSE}
## Install stable version of 'samplesim' ----
install.packages("samplesim")
```
Or you can install the development version from [GitHub](https://github.com/) with:
```{r eval = FALSE}
## Install 'remotes' package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
## Install development version of 'samplesim' ----
remotes::install_github("ahasverus/samplesim")
```
Then you can attach the package `samplesim`:
```{r eval = FALSE}
library("samplesim")
```
## Overview
Please read the
[Vignette](https://ahasverus.github.io/samplesim/articles/samplesim.html)
## Citation
Please cite this package as:
> Lecomte N., Ehrich D., Casajus N., Berteaux D., Cameron C., and Yoccoz N.G.
How many is enough? An R package for evaluating the effect of sample size on
estimates and precision of stable isotope mixing solutions.
Submitted to _Methods in Ecology and Evolution_.
Or alternatively:
> Casajus N., Cameron C., Ehrich D., and Lecomte N. (2021) samplesim: An R
package to investigate sample size effects in stable isotope mixing solutions.
R package version 1.0. URL: <https://github.com/ahasverus/samplesim>.
## Code of Conduct
Please note that the `samplesim` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.