https://github.com/r-lum/xlum

The R package 'xlum'
https://github.com/r-lum/xlum

geochronology luminescence luminescence-dating open-data open-science rpackage xlum xml

Last synced: 5 months ago
JSON representation

The R package 'xlum'

• Host: GitHub
• URL: https://github.com/r-lum/xlum
• Owner: R-Lum
• License: gpl-3.0
• Created: 2022-04-04T11:34:56.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-12T20:35:19.000Z (almost 2 years ago)
• Last Synced: 2025-01-22T19:45:11.923Z (over 1 year ago)
• Topics: geochronology, luminescence, luminescence-dating, open-data, open-science, rpackage, xlum, xml
• Language: R
• Homepage: https://r-lum.github.io/xlum/
• Size: 3.48 MB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.Rmd
  • License: LICENSE
  • Codemeta: codemeta.json

Awesome Lists containing this project

README

          
---

output: github_document

header-includes:

   - \usepackage{amsmath}

   - \usepackage{amssymb}

---

```{r, echo = FALSE, message=FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-"

)

library(xlum)

```

# xlum 

The R package `'xlum'` to interface `` a data format for exchange and long-term 

preservation of luminescence data.

[![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/#Concept)

[![CRAN](https://www.r-pkg.org/badges/version/xlum)](https://cran.r-project.org/package=xlum)

[![DOI](https://zenodo.org/badge/477672855.svg)](https://zenodo.org/badge/latestdoi/477672855)

[![Coverage Status](https://img.shields.io/codecov/c/github/R-Lum/xlum.svg)](https://app.codecov.io/github/R-Lum/xlum?branch=master)

[![R-CMD-check](https://github.com/R-Lum/xlum/workflows/GitHub Actions CI/badge.svg)](https://github.com/R-Lum/xlum/actions)

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

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

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

```{r, eval=FALSE}

install.packages("xlum")

```

To install the latest development builds directly from GitHub, run

```{r, eval=FALSE}

if(!require("devtools"))

  install.packages("devtools")

devtools::install_github("R-Lum/xlum@")

```

## Note

**The package comes without any guarantee!**

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

##  Funding

The [development of xlum](https://github.com/R-Lum/xlum_specification)

benefited 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 

* [xlum specification](https://github.com/R-Lum/xlum_specification)

* [xlum-python](https://github.com/SteveGrehl/xlum-python)

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