Data

Tools

Indexes

Applications

Experiments

Open Source Science

xlum

The R package 'xlum'

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

Science Score: 46.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    2 of 4 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (21.7%) to scientific vocabulary

Keywords

geochronology luminescence luminescence-dating open-data open-science rpackage xlum xml
Last synced: 4 months ago · JSON representation

Repository

The R package 'xlum'

Basic Info
Statistics
  • Stars: 1
  • Watchers: 4
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Topics
geochronology luminescence luminescence-dating open-data open-science rpackage xlum xml
Created almost 4 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog License Codemeta

README.Rmd 

---
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)

Owner

  • Name: RLum.Network
  • Login: R-Lum
  • Kind: organization
  • Email: developers@r-luminescence.org
  • Location: Europe

Enlightening the past and shaping the future

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "xlum",
  "description": "Support for the XLUM file format for exchange and long-term preservation of luminescence data. Facilitated are the import and export of XLUM files and the conversion from other formats commonly used to store luminescence (dating) data.",
  "name": "xlum: Read, Write, and Convert XLUM Data",
  "codeRepository": "https://github.com/R-Lum/xlum",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "0.1.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.5.0 RC (2025-04-04 r88126)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@uni-heidelberg.de",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Christoph",
      "familyName": "Burow",
      "@id": "https://orcid.org/0000-0002-5023-4046"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@uni-heidelberg.de",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "spelling",
      "name": "spelling",
      "version": ">= 2.2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=spelling"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.1.3",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 4.4"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "base64enc",
      "name": "base64enc",
      "version": ">= 0.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=base64enc"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "Luminescence",
      "name": "Luminescence",
      "version": ">= 1.0.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=Luminescence"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "xml2",
      "name": "xml2",
      "version": ">= 1.3.8",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=xml2"
    },
    "SystemRequirements": null
  },
  "fileSize": "90.215KB",
  "relatedLink": "https://r-lum.github.io/xlum/",
  "releaseNotes": "https://github.com/R-Lum/xlum/blob/master/NEWS.md",
  "readme": "https://github.com/R-Lum/xlum/blob/main/README.md",
  "contIntegration": "https://app.codecov.io/github/R-Lum/xlum?branch=master",
  "developmentStatus": "https://www.repostatus.org/#Concept",
  "keywords": [
    "geochronology",
    "luminescence",
    "luminescence-dating",
    "open-data",
    "open-science",
    "rpackage",
    "xml",
    "xlum"
  ]
}

GitHub Events

Total
  • Push event: 3
Last Year
  • Push event: 3

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 97
  • Total Committers: 4
  • Avg Commits per committer: 24.25
  • Development Distribution Score (DDS): 0.485
Past Year
  • Commits: 6
  • Committers: 1
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
RLumSK s****r@a****k 50
RLumSK s****r@u****e 43
Christoph Burow c****w@g****t 2
Sebastian Kreutzer R****K 2
Committer Domains (Top 20 + Academic)
gmx.net: 1 uni-heidelberg.de: 1 aber.ac.uk: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

DESCRIPTION cran
  • R >= 4.1 depends
  • utils * depends
  • Luminescence >= 0.9.19 imports
  • methods * imports
  • xml2 >= 1.3.3 imports
  • spelling >= 2.2 suggests
  • testthat >= 3.1.3 suggests
.github/workflows/GitHub_Actions_CI.yaml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite