-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
executable file
·78 lines (51 loc) · 3.32 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
---
output: rmarkdown::github_document
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
library(badger)
```
# divDyn <img src="man/figures/logo.png" align="right" width="120"/>
`r badge_devel("divDyn/r-package", "green")`
`r badge_cran_release("divDyn", "orange")`
`r badge_cran_download("divDyn", "grand-total", "yellow")`
`r badge_cran_checks("divDyn")`
`r badger::badge_doi(doi = "10.5281/zenodo.7056783", color = "blue")`
R package for quantifying diversity dynamics using fossil sampling data
See the webpage of the package for more info and tutorials: https://divDyn.github.io/r-package/
## News
- The next update of the package (v0.8.3) is now availble from the CRAN servers! As this is a major update, I suggest everyone to update their copy. See the change log below for the changes.
- The paper describing the package is available from the Wiley Online Library. You can download it from this link:
https://besjournals.onlinelibrary.wiley.com/doi/10.1111/2041-210X.13161
(or contact me, if you have problems). If you decide to use the methods implemented in this package, please refer to this document. The examples implemented can be reproduced with the files deposited at
https://github.com/divDyn/ddPhanero
using this (updated) vignette:
https://github.com/divDyn/ddPhanero/blob/master/doc/dd_phanero_web.html
## About the package
If you are interested in what this package does, or have questions about its use, please check out the first vignette: 'Handout to the R package 'divDyn' v0.8.3 for diversity dynamics from fossil occurrence data' here, accessible with
```{r, echo=TRUE, eval=FALSE}
libary(divdyn)
vignettes("handout")
```
As the package is still getting developed, please note that some interface changes might occurr based on the feedback of people and my own experience on what is easier to use. If you have any requirements or recommendations about what to add (or more importantly, if you find a mistake), do not hesitate to contact me at [email protected].
## Installing
### 1. From CRAN (v0.8.3)
You can install the appropriate binaries normally, by running
`install.packages("divDyn")`
### 2. Using the source tarball to install (v0.8.3)
This you can do with running
```
install.packages(
"https://zenodo.org/records/14202954/files/divDyn_0.8.3.tar.gz?download=1",
repos=NULL, type="source")
```
from the R console. Note that there is some code in the package that requires compilation. To do this, the most straightforward way is to install/use Rtools (https://cran.r-project.org/bin/windows/Rtools/) on Windows, and XCode https://developer.apple.com/xcode/ on Mac.
The sources of the older versions are also in the _archive/source folder. You can access earlier versions by changing the version number in the command above.
### 3. Using the repository files and 'devtools' to install (v0.8.3)
To do this:
- You need a compiler, as for method 2
- Make sure that the 'devtools' package is installed
- Run `devtools::install_github("divDyn/r-package")`
If the frist method is not working for you, and you do not want to mess around with a compiler and such, then contact me and I will find a way to compile binaries for you.
# Change log
See the change log here: [Change Log](https://github.com/divDyn/r-package/blob/master/inst/NEWS)