-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathREADME.Rmd
More file actions
89 lines (58 loc) · 4.16 KB
/
Copy pathREADME.Rmd
File metadata and controls
89 lines (58 loc) · 4.16 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
---
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%"
)
```
# ASTR (Archaemetric Standards and Tools in R)
<!-- badges: start -->
[](https://github.com/archaeothommy/ASTR/actions/workflows/R-CMD-check.yaml)
[](https://CRAN.R-project.org/package=ASTR)
[](https://codecov.io/gh/archaeothommy/ASTR)
<!-- badges: end -->
ASTR defines and implements a community reporting standard for archaeometric datasets. It also provides easy-to-use functions for common plots, statistical analyses, data processing, and data transformation workflows in archaeometry.
## Overview
ASTR aims to increase reproducibility of data processing by facilitating the use of scripting languages in archeometry in the narrower sense, i.e., the material scientific investigation of usually inorganic archaeological materials.
### Community reporting standard
The community reporting standard defines a [set of conventions on the structure and naming of datasets](vignettes/VG.ASTRschema.0.0.2.Rmd) to make them interoperable and allow automated handling of the data. Based on these conventions, ASTR
* Recognises and seamlessly isotopic and chemical data, their units, and analytical precision,
* Handles unit conversion on the fly, including non-SI units such as *ppm*, *at%*, and *cps* (counts per second) and between oxides and elements
### Tools
The collection provides easy-to-use functions for a wide range of tasks such as
* [ggplot2](https://ggplot2.tidyverse.org/) geoms for standard plots (e.g., spidergrams, KDE)
* Material classification (e.g., copper types)
* Data transformation and processing (e.g., calculation of δ-values from standard-sample-bracketing measurements)
* Data conversion (e.g., calculation of lead isotope age model parameters)
* Statistics (e.g. distribution of data in a pointcloud of reference data)
* Normalisation of data to standard compositions (e.g., chondritic composition)
* Unit conversion (e.g., at% to wt% and vice versa)
See the full list on the [package website](https://archaeothommy.github.io/ASTR/index.html).
Functions do not expect datasets according to the community reporting standard but default values for their input follow its conventions, making them particularly easy to use.
<!--
### Example
include here a small example for inputting a example data set and plotting it such as
library(ASTR)
library(ggplot2)
df <- import()
ggplot(df) +
geom_spidergram()
-->
## Installation
You can install the development version of ASTR from [GitHub](https://github.com/) with:
``` {r, eval = FALSE}
install.packages("pak")
pak::pak("archaeothommy/ASTR")
```
## Getting started
We recommend reading the following resources to become familiar with the package:
* Community reporting standard: [Conventions](vignettes/VG.ASTRschema.0.0.2.Rmd) and their [explanation](vignettes/VG.ASTR.Conventions.explained.Rmd)
## Contributing and Code of Conduct
Please read our [contributor guide](https://archaeothommy.github.io/ASTR/CONTRIBUTING.html) to learn how to contribute to ASTR. The ASTR project is released with a [Contributor Code of Conduct](https://archaeothommy.github.io/ASTR/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
## Acknowledgements and funding
ASTR was initiated in the workshop *Towards an Archaeological Science Toolbox in R “ASTR”* at the [Lorentz Center](https://www.lorentzcenter.nl/) in Leiden (The Netherlands). In addition to the in-kind funding of the Lorentz Center, the workshop received funding from the Stichting Nederlands Museum voor Anthropologie en Praehistorie (Foundation for Anthropology and Prehistory in the Netherlands). The workshop and further development of ASTR received funding from the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) – project 571205551.