README.Rmd

---
output:
  md_document:
    variant: gfm # github flavored markdow
header-includes:
   - \usepackage{amsmath}
   - \usepackage{amssymb}
---
<!-- README.md was auto-generated by README.Rmd. Please DO NOT edit by hand!-->

```{r, echo = FALSE, message=FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-"
)
library(Luminescence)
```

# Luminescence <img width=120px src="man/figures/Luminescence_logo.png" align="right" />

The R package `'Luminescence'` by the R-Luminescence Group provides a collection of various R functions for luminescence dating data analysis.

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN](https://www.r-pkg.org/badges/version/Luminescence)](https://CRAN.R-project.org/package=Luminescence)
[![CRAN DOI](https://img.shields.io/badge/DOI-10.32614/CRAN.package.Luminescence-1f57b6?style=flat&link=https://doi.org/10.32614/CRAN.package.Luminescence)](https://doi.org/10.32614/CRAN.package.Luminescence)
[![ZENODO DOI](https://zenodo.org/badge/23153315.svg)](https://zenodo.org/badge/latestdoi/23153315)

[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/Luminescence)](https://www.r-pkg.org/pkg/Luminescence)
[![Downloads](https://cranlogs.r-pkg.org/badges/Luminescence)](https://www.r-pkg.org/pkg/Luminescence)
[![Downloads](https://cranlogs.r-pkg.org/badges/last-week/Luminescence)](https://www.r-pkg.org/pkg/Luminescence)
[![Downloads](https://cranlogs.r-pkg.org/badges/last-day/Luminescence)](https://www.r-pkg.org/pkg/Luminescence)

[![R-CMD-check](https://github.com/R-Lum/Luminescence/actions/workflows/R-CMD-check.yml/badge.svg)](https://github.com/R-Lum/Luminescence/actions)
[![Coverage Status](https://img.shields.io/codecov/c/github/R-Lum/Luminescence.svg)](https://app.codecov.io/github/R-Lum/Luminescence?branch=master)

## Social media and other resources 
Visit our [R-Luminescence homepage](https://r-luminescence.org).

## Installation

#### i. Requirements

* *Windows (32/64bit)*:  [Rtools](https://cran.r-project.org/bin/windows/Rtools/) (provided by CRAN)
* *macOS*: [Xcode](https://developer.apple.com/) (provided by Apple)
* *Linux*: [gcc](https://gcc.gnu.org) often comes pre-installed in most distributions. 

#### ii. Install the package

Install any development versions using our [RStudio](https://posit.co) add-in

![](man/figures/README-Screenshot_AddIn.png)


##### The plain **R** way

To install the stable version from CRAN, simply run the following from an R console:

```{r, eval=FALSE}
install.packages("Luminescence")
```

To install the latest development builds directly from GitHub, run

```{r, eval=FALSE}
if(!require("devtools"))
  install.packages("devtools")
devtools::install_github("R-Lum/Luminescence@<wanted branch>")
```

## Contribute

The R luminescence project is based on and evolves from ideas, contributions and constructive criticism of its users. Help us to maintain and develop the package, to find bugs and create new functions as well as a user-friendly design. Try https://github.com/R-Lum/Luminescence/issues or write us an [e-mail](mailto:developers@r-luminescence.org) if anything crosses your mind or if you want your new self-written function to be to implemented. You are kindly invited to bring forward the package with us!

## Note

**The package comes without any guarantee!**

Please further note that this version is a development version and may change day by day. For stable branches please visit
the package on [CRAN Luminescence](https://CRAN.R-project.org/package=Luminescence).

## License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
[GNU General Public License](https://github.com/R-Lum/Luminescence/blob/master/LICENSE) for more details.

## Funding

* 2011-2013:  The initial version of the package was developed in the framework of the
PhD thesis by Sebastian Kreutzer, while he was funded through the DFG programme "Rekonstruktion der Umweltbedingungen
des Spätpleistozäns in Mittelsachsen anhand von Löss-Paläobodensequenzen"
([GEPRIS id: 46526743](https://gepris.dfg.de/gepris/projekt/46526743))

* 2014-2018: Cooperation and personal exchange between the developers is gratefully
funded by the DFG in the framework of the program
"Scientific Networks". Project title: "RLum.Network: Ein
Wissenschaftsnetzwerk zur Analyse von Lumineszenzdaten mit R" ([GEPRIS id: 250974974 ](https://gepris.dfg.de/gepris/projekt/250974974))

* 05/2014-12/2019: The work of Sebastian Kreutzer as maintainer of the package was supported
by LabEx LaScArBx (ANR - n. ANR-10-LABX-52).

* 01/2020-04/2022: Sebastian Kreutzer as maintainer of the package has received funding
from the European Union’s Horizon 2020 research and innovation programme under
the Marie Skłodowska-Curie grant agreement [No 844457 (CREDit)](https://cordis.europa.eu/project/id/844457), 
and could continue maintaining the package.

* since 03/2023: Sebastian Kreutzer as maintainer of the package receives funding
from the DFG Heisenberg programme [No 505822867](https://gepris.dfg.de/gepris/projekt/505822867).

* since 08/2024 the future and sustainable development of `'Luminescence'` towards
better reproducibility and usability is supported through the DFG programme 
"REPLAY: REProducible Luminescence Data AnalYses" [No 528704761](https://gepris.dfg.de/gepris/projekt/528704761?language=en)
led by Dr Sebastian Kreutzer (PI at Heidelberg University, DE) and Dr Thomas Kolb (PI at Justus-Liebig-University Giessen, DE).

* All other authors gratefully received additional funding from various public funding bodies. 

## Related projects 

* [RLumModel](https://github.com/R-Lum/RLumModel)
* [RLumShiny](https://github.com/R-Lum/RLumShiny)
* [RLumDocker](https://github.com/R-Lum/RLumDocker)
* [BayLum](https://github.com/crp2a/BayLum )
* [RCarb](https://github.com/R-Lum/RCarb)
* [RLumCarlo](https://github.com/R-Lum/RLumCarlo)


```{r Outro, echo=FALSE}
detach("package:Luminescence")
```