README.Rmd

---
output: github_document
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(RLumSTARR)
```

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

**S**pa**T**i**A**lly **R**esolved **R**adiofluorescence 

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
[![CRAN](https://www.r-pkg.org/badges/version/RLumSTARR)](https://cran.r-project.org/package=RLumSTARR)
[![R-CMD-check](https://github.com/R-Lum/RLumSTARR/workflows/GitHub Actions CI/badge.svg)](https://github.com/R-Lum/RLumSTARR/actions)

**Note: This is an experimental R package and not (yet) recommended for productive usage.**

## Installation

To install the latest development builds directly from GitHub, run

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

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

## Funding 

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)](https://cordis.europa.eu/project/id/844457).

## Related projects 

* [Luminescence](https://github.com/R-Lum/Luminescence)