Skip to main content
Log in

KarstID: an R Shiny application for the analysis of karst spring discharge time series and the classification of karst system hydrological functioning

  • Original Article
  • Published:
Environmental Earth Sciences Aims and scope Submit manuscript

Abstract

Karst spring discharge time series analyses are often used to gain preliminary insights into the hydrological functioning of a karst system. KarstID is an R Shiny application that facilitates the completion of such analyses and allows the identification of karst system hydrological functioning. The application permits (i) to perform statistical, recession curves, classified discharges and signal (simple correlational and spectral) analyses; (ii) to calculate relevant indicators representative of distinct hydrological characteristics of karst systems, (iii) to classify karst systems hydrological functioning; and (iv) to compare the results to a database of 78 karst systems. The KarstID software is free, open source, and actively developed on a developer community platform. The user-friendly installation and launch make it especially accessible even for non-programmers; therefore, KarstID can be used for both research and educational purposes. The application and its user manual are both available on the French SNO KARST website (https://sokarst.org/en/softwares-en/karstid-en/).

This is a preview of subscription content, log in via an institution to check access.

Access this article

Price excludes VAT (USA)
Tax calculation will be finalised during checkout.

Instant access to the full article PDF.

Fig. 1
Fig. 2
Fig. 3
Fig. 4
Fig. 5
Fig. 6

Similar content being viewed by others

Data availability

KarstID is a free R Shiny application embedded into an R package (4.6 Mo), developed by Guillaume Cinkus (guillaume.cinkus@umontpellier.fr) and first made available in 2021. The software requires R version 4.0.0 or later, can be run on any web browser, and is licensed under Creative Commons Attribution 4.0 International. The code repository is available on GitHub: https://github.com/busemorose/KarstID.

References

Download references

Acknowledgements

The French Ministry of Higher Education and Research is thanked for the thesis scholarship of G. Cinkus. This application is developed within the framework of (i) the KARST observatory network (www.sokarst.org) initiated by the INSU/CNRS, which aims to strengthen knowledge-sharing and promote cross-disciplinary research on karst systems; and (ii) the KARMA project (Karst Aquifer Resources availability and quality in the Mediterranean Area, http://karma-project.org/). The DREAL Provence Alpes-Côtes d’Azur (PACA) is also acknowledged for providing Fontaine de Vaucluse’s data. The manuscript was written with the Rmarkdown framework (Allaire et al., 2021; Xie et al., 2020, 2018), using R (R Core Team, 2021) and knitr (Xie, 2021). KarstID software uses functions from the following packages: data.table (Dowle and Srinivasan 2021), DT (Xie et al., 2021), minpack.lm (Elzhov et al., 2016), padr (Thoen, 2021), plotly (Sievert, 2020), shiny (Chang et al., 2021), shinyFeedback (Merlino and Howard, 2020), shinyhelper (Mason-Thom, 2019), shinyjs (Attali, 2020), waiter (Coene, 2021), zoo (Zeileis and Grothendieck, 2005), and readxl, readr, dplyr, stringr, magrittr, ggplot2, lubridate (Wickham et al., 2019). The KarstID package was developed and structured using devtools (Wickham et al., 2021), usethis (Wickham and Bryan, 2021) and testthat (Wickham, 2011) packages.

Funding

The authors declare that no funds, grants, or other support were received during the preparation of this manuscript.

Author information

Authors and Affiliations

Authors

Contributions

GC, NM and HJ worked on the methodology and underlying sciences; GC programmed, coded and developed the application; GC wrote the original draft; GC, NM and HJ reviewed and edited the original draft.

Corresponding author

Correspondence to Guillaume Cinkus.

Ethics declarations

Conflict of interest

The authors have no relevant financial or non-financial interests to disclose.

Additional information

Publisher's Note

Springer Nature remains neutral with regard to jurisdictional claims in published maps and institutional affiliations.

Appendix A

Appendix A

A. Comparison of indicators values from the correlational and spectral analyses between the original publication of Mangin (1984) and recent work of Cinkus et al. (2021)—calculated with KarstID. The exact time series used by Mangin (1984) are unavailable so different—and more recent—time series were used by Cinkus et al. (2021).

System

Indicator

Mangin (1984)

Cinkus et al. (2021)

Aliou

Memory effect (days)

4

5

Regulation time (days)

14

11

Baget

Memory effect (days)

15

18

Regulation time (days)

22.5

24

Rights and permissions

Springer Nature or its licensor (e.g. a society or other partner) holds exclusive rights to this article under a publishing agreement with the author(s) or other rightsholder(s); author self-archiving of the accepted manuscript version of this article is solely governed by the terms of such publishing agreement and applicable law.

Reprints and permissions

About this article

Check for updates. Verify currency and authenticity via CrossMark

Cite this article

Cinkus, G., Mazzilli, N. & Jourde, H. KarstID: an R Shiny application for the analysis of karst spring discharge time series and the classification of karst system hydrological functioning. Environ Earth Sci 82, 136 (2023). https://doi.org/10.1007/s12665-023-10830-5

Download citation

  • Received:

  • Accepted:

  • Published:

  • DOI: https://doi.org/10.1007/s12665-023-10830-5

Keywords

Navigation