-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
70 lines (46 loc) · 2.76 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
# Please put your title here to include it in the file below.
Title <- "Title of your paper goes here"
```
# pmird
<!-- [ -->
```{r pmird_icon, echo = FALSE, eval = FALSE}
knitr::include_graphics("./man/figures/pmird_icon.svg")
```
<!--]{style="float:right"} -->
**peat mid infrared spectra data compendium**
<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->
<!-- [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh///master?urlpath=rstudio) -->
pmird is an R package that has the aim to provide a comprehensive and easily to access data collection of mid infrared spectra (MIR) of peat and related material (for example peat forming vegetation or DOM).
pmird is designed as community-based project, meaning that everybody can contribute and benefit from this project. Learn more about [why you should contribute](https://henningte.github.io/pmird/articles/a01-Why-to-contribute.html) to pmird and [how you can use the data](https://henningte.github.io/pmird/articles/a05-How-to-access-data.html)!
pmird is part of my PhD project. I want to be fully transparent on [what I plan to do with the data](https://henningte.github.io/pmird/articles/a02-What-I-plan-to-do-with-the-data.html).
<!-- ### How to cite
Please cite this compendium as:
> Authors, (`r format(Sys.Date(), "%Y")`). _Compendium of R code and data for `r Title`_. Accessed `r format(Sys.Date(), "%d %b %Y")`. Online at <https://doi.org/xxx/xxx>
### How to download or install
You can download the compendium as a zip from from this URL: </archive/master.zip>
Or you can install this compendium as an R package, pmird, from GitHub with:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
remotes::install_github("/")
```
-->
### Licenses
**Text and figures :** [CC-BY-4.0](http://creativecommons.org/licenses/by/4.0/)
**Code :** See the [DESCRIPTION](https://github.com/henningte/pmird/blob/master/DESCRIPTION) file
**Data :** [CC-BY-4.0](http://creativecommons.org/licenses/by/4.0/)
### Contributions
We welcome contributions from everyone. Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
If you want to contribute data to pmird, please see [How to contribute](https://henningte.github.io/pmird/articles/a03-How-to-contribute.html).
If you want to contribute to the code, please see our [code contributor guidelines](CONTRIBUTING.md).