README.Rmd

---
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 = "README-"
)
``` 

# Electron-Spin-Resonance (ESR) <a href='https://tzerk.github.io/ESR/'><img src='man/figures/logo.png' align="right" height="138.5" /></a>

<!-- badges: start -->
[![Build status](https://ci.appveyor.com/api/projects/status/emdl7is8oa7kh5i0/branch/master?svg=true)](https://ci.appveyor.com/project/tzerk/esr/branch/master)
[![Build Status](https://travis-ci.org/tzerk/ESR.svg?branch=master)](https://travis-ci.org/tzerk/ESR)
<!-- badges: end -->

> [Find a full documentation of the package on the project page](https://tzerk.github.io/ESR/)

## Overview

The R package 'ESR' provides a collection of various R functions for electron spin resonance dating data analysis.



## Installation

The 'ESR' package is not available on the official CRAN servers. 

However, the latest development builds can directly be installed from GitHub. Simply run the following from an R console

```{r, eval = FALSE}
if(!require("devtools"))
  install.packages("devtools")
devtools::install_github("tzerk/ESR")
```

## Contribute

The R package 'ESR' is based on and evolves from ideas, contributions and constructive criticism of its users. Help me to maintain and develop the package, to find bugs and create new functions as well as a user-friendly design. Visit my [homepage](http://zerk.canopus.uberspace.de) or write me an [e-mail](mailto:christoph.burow@gmx.net) 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 me!

## Note

This version is a development version and it comes without any guarentee!

## License

The ESR package is licensed under the GPLv3. See these files in the main directory for additional details: 

- LICENSE - ESR package license (GPLv3)