README.Rmd

---
title: "Trapped Charge Data Analysis: Task View"
author: "Sebastian Kreutzer"
date: "(last update: `r Sys.Date()`)"
output:
  github_document: 
    toc: true
    toc_depth: 2
  # pdf_document:
  #   latex_engine: pdflatex
  #   keep_tex: true
  #   pandoc_args: "--wrap=preserve"
  html_document: 
    toc: true
    toc_float: yes
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}
rm(list = ls())
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

```{r load helper functions, echo = FALSE, message=FALSE}
source("R_helpers/helpers.R")
```

# About 

In analogy of the [CRAN task view lists](https://cran.rstudio.com/web/views/), 
this list provides an overview of freely available tools for trapped charge (dating) data analysis (e.g., luminescence and ESR data). Tasks, software tools and data repositories are ordered alphabetically. URLs are automatically tested every time this list is updated, information from R packages are extracted and updated automatically from [CRAN](https://cloud.r-project.org) (version, description).

Not listed are:

* Single scripts (e.g., functions or XLS-sheets usually without a dedicated name)
* Software not accessible free of charge through the internet

If **your software is missing** or you did spot a mistake, please let me know via  https://github.com/RLumSK/luminescence-tv/issues. 


# Mission tasks 

```{r, echo = FALSE, warning=FALSE, message=FALSE}
##import software table 
df <- suppressWarnings(
    read.table(
    "input/Software_list.csv",
    header = TRUE,
    sep = ",",
    stringsAsFactors = FALSE
    )
  )
```

```{r, echo=FALSE, warning = FALSE, message=FALSE, prompt=FALSE}
##check URL
df <- .url_check(df, verbose = FALSE)

##check for version and description
df <- .fill_description(df)

##rewrite dates for GitHub code
df <- .last_GitHubcommit(df)

##export data.frame
write.table(
  x = df,
  file = paste0("export/",Sys.Date(),"_software_table.csv"),
  append = FALSE,
  sep = ",",
  col.names = TRUE
  )

##split list
df_list <- .sort_software(df)
```

Total number of listed tools: `r nrow(df)`

`r .render_list(df_list)`

# Legend{-}

|Icon             | Meaning     |
|-----------------|-------------|
|[0.1]            | Indicates the latest available version, here 0.1 |
|![](images/osi_logo.png) | This software is open source |
|<img width=60px src='images/badges_r_package.svg'/> | Type of software (here: R package) |

Some of the badges are created using https://shields.io.