-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
148 lines (120 loc) · 5.65 KB
/
README.Rmd
File metadata and controls
148 lines (120 loc) · 5.65 KB
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
---
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 = NULL
)
Sys.setenv(LANGUAGE = "en") # Force locale
```
# folio <img width=120px src="man/figures/logo.png" align="right" />
<!-- badges: start -->
[](https://ci.codeberg.org/repos/14690){.pkgdown-devel}
[](https://cran.r-project.org/package=folio){.pkgdown-devel}
[](https://tesselle.r-universe.dev){.pkgdown-devel}
[](https://cran.r-project.org/package=folio){.pkgdown-release}
[](https://cran.r-project.org/web/checks/check_results_folio.html){.pkgdown-release}
[](https://cran.r-project.org/package=folio){.pkgdown-release}
[](https://www.repostatus.org/#active)
[](https://doi.org/10.5281/zenodo.4476182)
[](https://archive.softwareheritage.org/browse/origin/?origin_url=https://codeberg.org/tesselle/folio)
<!-- badges: end -->
## Overview
Datasets for teaching quantitative approaches and modeling in archaeology and paleontology. This package provides several types of data related to broad topics (cultural evolution, radiocarbon dating, paleoenvironments, etc.), which can be used to illustrate statistical methods in the classroom (multivariate data analysis, compositional data analysis, diversity measurement, etc.).
This package is for teaching purposes only: some datasets may be outdated.
**When using folio, you must cite the relevant publications for each dataset (see the documentation).**
---
```{r citation, echo=FALSE, comment='', results='asis'}
cite <- utils::citation("folio")
print(cite, bibtex = FALSE)
```
## Installation
You can install the released version of **folio** from [CRAN](https://CRAN.R-project.org) with:
```{r cran-installation, eval=FALSE}
install.packages("folio")
```
And the development version from [Codeberg](https://codeberg.org/) with:
```{r gh-installation, eval=FALSE}
# install.packages("remotes")
remotes::install_git("https://codeberg.org/tesselle/folio")
```
## Usage
```{r, fig.width=5, fig.height=5, fig.align='center'}
## Arnold and Libby's Curve of Knowns
## Replicate fig. 1 from Arnold and Libby (1949)
data("arnold1949")
fit <- lm(activity_found ~ age_expected, data = arnold1949)
summary(fit)
plot(
x = arnold1949$age_expected,
y = arnold1949$activity_found,
type = "p",
pch = 16,
xlab = "Historical age (years)",
ylab = "Specific activity (C/m/g)",
main = "Samples of known ages"
)
segments(
x0 = arnold1949$age_expected,
y0 = arnold1949$activity_found - arnold1949$activity_found_error,
x1 = arnold1949$age_expected,
y1 = arnold1949$activity_found + arnold1949$activity_found_error
)
segments(
x0 = arnold1949$age_expected - arnold1949$age_expected_error,
y0 = arnold1949$activity_found,
x1 = arnold1949$age_expected + arnold1949$age_expected_error,
y1 = arnold1949$activity_found
)
abline(fit, col = "red")
```
## Related Works
* [**archdata**](https://cran.r-project.org/package=archdata) includes archaeological datasets used in [*Quantitative Methods in Archaeology Using R*](https://doi.org/10.1017/9781139628730) by David L. Carlson (2017).
* [**historydata**](https://cran.r-project.org/package=historydata) includes datasets intended for historians learning R.
## Contributing
Please note that the **folio** project is released with a [Contributor Code of Conduct](https://www.tesselle.org/conduct.html). By contributing to this project, you agree to abide by its terms.
```{r metadata, include=FALSE}
## Update codemeta.json
codemetar::write_codemeta(verbose = FALSE)
## Update CITATION.cff
cff_keys <- list(
identifiers = list(
list(description = "The concept DOI.",
type = "doi",
value = "10.5281/zenodo.4476182"),
list(description = "The versioned DOI for version 0.1.0.",
type = "doi",
value = "10.5281/zenodo.4476183"),
list(description = "The versioned DOI for version 1.0.0.",
type = "doi",
value = "10.5281/zenodo.4537570"),
list(description = "The versioned DOI for version 1.1.0.",
type = "doi",
value = "10.5281/zenodo.6523636"),
list(description = "The versioned DOI for version 1.2.0.",
type = "doi",
value = "10.5281/zenodo.6993457"),
list(description = "The versioned DOI for version 1.3.0.",
type = "doi",
value = "10.5281/zenodo.7267613"),
list(description = "The versioned DOI for version 1.4.0.",
type = "doi",
value = "10.5281/zenodo.10708937"),
list(description = "The versioned DOI for version 1.5.0.",
type = "doi",
value = "10.5281/zenodo.13643896"),
list(description = "The versioned DOI for version 1.5.1.",
type = "doi",
value = "10.5281/zenodo.15450499"),
list(description = "The CRAN DOI",
type = "doi",
value = "10.32614/cran.package.folio")
)
)
cff <- cffr::cff_create("DESCRIPTION", keys = cff_keys)
if (cffr::cff_validate(cff)) cffr::cff_write(cff, outfile = "CITATION.cff")
```