




<!-- README.md was auto-generated by README.Rmd. Please DO NOT edit by hand!-->

# RLumModel <img width=120px src="man/figures/RLumModel_logo.svg" align="right" />

[![CRAN](https://www.r-pkg.org/badges/version/RLumModel)](https://CRAN.R-project.org/package=RLumModel)
[![CRAN
DOI](https://img.shields.io/badge/doi-10.32614/CRAN.package.RLumModel-blue.svg)](https://doi.org/10.32614/CRAN.package.RLumModel)
[![DOI](https://zenodo.org/badge/47547833.svg)](https://zenodo.org/badge/latestdoi/47547833)
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/RLumModel)](https://www.r-pkg.org/pkg/RLumModel)
[![Downloads](https://cranlogs.r-pkg.org/badges/RLumModel)](https://www.r-pkg.org/pkg/RLumModel)
[![Downloads](https://cranlogs.r-pkg.org/badges/last-week/RLumModel)](https://www.r-pkg.org/pkg/RLumModel)
[![Downloads](https://cranlogs.r-pkg.org/badges/last-day/RLumModel)](https://www.r-pkg.org/pkg/RLumModel)
[![R-CMD-check](https://github.com/R-Lum/RLumModel/workflows/GitHub%20Actions%20CI/badge.svg)](https://github.com/R-Lum/RLumModel/actions)
[![Build
status](https://ci.appveyor.com/api/projects/status/42umfq97ifr021mk/branch/master?svg=true)](https://ci.appveyor.com/project/RLumSK/rlummodel/branch/master)
[![codecov](https://img.shields.io/codecov/c/github/R-Lum/RLumModel.svg)](https://app.codecov.io/github/R-Lum/RLumModel)

The **R** package `'RLumModel'` by Johannes Friedrich (University of
Bayreuth, Germany), Sebastian Kreutzer (Geography & Earth Sciences,
Aberystwyth University, United Kingdom) and Christoph Schmidt
(University of Lausanne, Switzerland) provides a collection of various R
functions modelling luminescence signals in quartz and
Al<sub>2</sub>O<sub>3</sub>, based on energy-band models.

For an introduction and further details, visit the [RLumModel
homepage](https://r-lum.github.io/RLumModel/).

## Installation

### Install the package

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

``` r
install.packages("RLumModel")
```

To install the latest development builds directly from GitHub, run

``` r
if(!require("devtools"))
  install.packages("devtools")
devtools::install_github("R-Lum/RLumModel@master")
```

To install a developer build other than ‘master’, replace the term
‘master’ in the codeline by the name of the wanted developer build.

### Requirements

Depending on your OS please download and install one of the following:

- *Windows*: [Rtools](https://cran.r-project.org/bin/windows/Rtools/)
  (provided by CRAN)
- *macOS*: [Xcode](https://developer.apple.com/xcode/) (provided by
  Apple)
- *Linux*: [gcc](https://gcc.gnu.org) often comes pre-installed in most
  distributions. Should [gcc](https://gcc.gnu.org) be not available,
  however, we kindly refer to the exhaustive collection of installation
  guides depending on the Linux distribution.

## Using RLumModel

### Simple Example

``` r
model <- "Bailey2001"

sequence <- list(
    IRR = c(20, 10, 1),
    TL = c(20, 500, 5))
    
model.output <- model_LuminescenceSignals(
    model = model,
    sequence = sequence,
    verbose = FALSE
)
```

![](man/figures/README-unnamed-chunk-4-1.png)<!-- -->

## 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.

## 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/RLumModel/blob/master/LICENSE) for
more details.

## <span class="glyphicon glyphicon-euro"></span> Funding

The [development of RLumModel](https://github.com/R-Lum/RLumModel)
benefited from the support by various funding bodies:

- The initial work by Johannes Friedrich, Sebastian Kreutzer and
  Christoph Schmidt was supported by the DFG (2015–2018, SCHM 3051/4-1,
  “Modelling quartz luminescence signal dynamics relevant for dating and
  dosimetry”, SCHM 3051/4-1)

- The work of Sebastian Kreutzer as package author was supported by
  LabEx LaScArBx (ANR - n. ANR-10-LABX-52) between 2017 and 2019.

- From 2020, Sebastian Kreutzer received funding from the European
  Union’s Horizon 2020 research and innovation programme under the Marie
  Skłodowska-Curie grant agreement No 844457 (project: CREDit).

## Related projects

- [Luminescence](https://github.com/R-Lum/Luminescence)
- [RLumShiny](https://github.com/tzerk/RLumShiny)
- [RLumCarlo](https://github.com/R-Lum/RLumCarlo)
