Skip to content

This is a repository that hosts the tool to calculate the costs of standard observations to upgrade and operate eLTER sites.

License

Notifications You must be signed in to change notification settings

allantsouza/eLTER-SO-Costs-web-application

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

76 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

eLTER SO Costs web application

DOI

Quick Links

Authors ๐Ÿ‘ฅ

CRediT author statement ๐Ÿ‘จโ€๐Ÿ”ฌ ๐Ÿ‘ฉโ€๐Ÿ”ฌ

Contributor Contributions
Allan T. Souza Conceptualization, Data Curation, Formal analysis, Methodology, Software, Validation, Visualization, Writing - Original Draft.
Syed Ashraful Alam Conceptualization, Validation, Visualization, Writing - Review & Editing.
Terhi Rasilo Conceptualization, Project Administration, Validation, Writing - Review & Editing.
Steffen Zacharias Conceptualization, Data Curation, Investigation, Supervision, Validation, Writing - Review & Editing.
Jaana Bรคck Conceptualization, Data Curation, Funding Acquisition, Investigation, Project Administration, Resources, Supervision, Validation, Writing - Review & Editing.

Access policy โš–๏ธ

  • This project is open and freely available for use under the terms of the CC0 1.0. For more information about the access rights and usage policies, please refer to the license file.

Context and aims ๐Ÿ“– ๐ŸŽฏ

This repository hosts the information used to build the eLTER SO Costs web application. This tool is a specialized resource designed to assist the eLTER (European Long-Term Ecosystem Research) community in estimating the costs associated with upgrading and operating standard observations across various eLTER sites.

The essence of this tool lies in its ability to adapt calculations based on unique site-specific criteria, ensuring tailored cost estimations. Key factors taken into consideration include the site category, the habitats, the focus spheres, and the potential co-location with other Research Infrastructures, which cover the costs of specific standard observations.

The goal of this tool is to provide a user-friendly, efficient, and reliable means for the eLTER community to plan and allocate resources effectively.

Input data ๐Ÿ’พ

The input data was built based on the agreement of the eLTER community regarding the standard observations. The data is located at the data folder and contains consensus information on the target sampling protocols, equipment, as well as estimations on the costs associated to upgrade and operate the standard observations.

Structure of files ๐Ÿ“‚

โ”œโ”€โ”€ .github # Folder containing information how to interact with the repository on GitHub
โ”‚ โ”œโ”€โ”€ bug_report.md # Instructions to bug reporting
โ”‚ โ”œโ”€โ”€ feature_request.md # Instructions to fearure requesting
โ”‚ โ”œโ”€โ”€ CODE_OF_CONDUCT.md # Information on the code of conduct of the repository
โ”‚ โ””โ”€โ”€ CONTRIBUTING.md # Instructions to contribute to this repository
โ”œโ”€โ”€ data # Folder for input data used by the app
โ”‚ โ”œโ”€โ”€ eLTER-SO-costs_list-of-standard-observations.xlsx # Data file in xlsx format
โ”‚ โ””โ”€โ”€ eLTER-SO-costs_standard-observations-detailed-costs_V18.csv # Data file in csv format
โ”œโ”€โ”€ www # Folder containing web assets
โ”‚ โ”œโ”€โ”€ eLTER-SO-costs_landing-page-picture.jpg # Picture for the web application landing page
โ”‚ โ”œโ”€โ”€ eLTER-SO-costs_elter-logo.png # eLTER simplified logo in png format
โ”‚ โ”œโ”€โ”€ eLTER-SO-costs_application-logo.jpg # SO Costs logo in jpg format
โ”‚ โ””โ”€โ”€ eLTER-SO-Costs_app-webinar-20240328_v1.0.0.pdf # slide presentation introducing the application
โ”œโ”€โ”€ app.R # The main application script for the Shiny web app
โ”œโ”€โ”€ eLTER-SO-costs_input-data-standardization.R # file to process the changes in input data
โ”œโ”€โ”€ .Rprofile # R project-specific configuration file
โ”œโ”€โ”€ eLTER-SO-costs-App.Rproj # RStudio project file
โ”œโ”€โ”€ .gitignore # Lists files to be ignored by version control system
โ”œโ”€โ”€ LICENSE # The full text of the license for the project
โ”œโ”€โ”€ README.html # Compiled HTML from README.md for detailed project information
โ”œโ”€โ”€ README.md # Markdown text providing an overview of the project
โ”œโ”€โ”€ CITATION.cff # Information on how to cite the repository
โ”œโ”€โ”€ renv # R environment setup with reproducibility in mind
โ”‚ โ””โ”€โ”€ ... # folders and files by renv to compile the needed information for reproducibility   
โ””โ”€โ”€ renv.lock # Lock file to capture the state of the R environment

Development ๐Ÿ‘จโ€๐Ÿ’ป

The web application is coded entirely in the R programming language, with a user interface developed using R Shiny. R Shiny is a powerful framework for building interactive web applications directly from R scripts, making it an ideal choice for creating accessible and user-friendly tools.

Web application workflow โš™๏ธ

  • Initial setup and library loading

    • The app begins by installing necessary R packages and loading them into the session. This ensures that all required functions and UI elements are available for use.
  • Data preparation

    • Reads and processes two datasets
      • one detailing the costs associated with Standard Observations (SOs) and another providing metadata on SOs. The app performs cleaning, filtering, and merging operations to prepare the data for analysis.
  • User Interface (UI) construction

    • Constructs a web interface with multiple tabs and input options. Users can navigate through these tabs to input specific parameters related to their site, such as category, habitat, and focus spheres, and to manage the list of SOs relevant to their needs.
  • Dynamic parameter selection and SO filtering

    • Based on user inputs regarding site characteristics, the app filters the list of SOs to only include those relevant to the user's specific conditions. Users can further refine this list by deselecting any SOs already covered or not needed.
  • Cost calculation and data aggregation

    • For the selected SOs, the app calculates various costs (e.g., purchase, maintenance, sampling, lab analysis) and aggregates this data to provide a comprehensive view of the financial requirements for implementing and maintaining the SOs at the user's site.
  • Visualization and insights

    • Generates visualizations that offer insights into the cost distribution by type and sphere, as well as the total number of SOs required. These visualizations help users understand the financial and operational implications of their selections.
  • Downloading results

    • Provides options for users to download detailed cost breakdowns and visualizations. This feature allows for easy sharing and reporting of the findings generated by the app.
  • User guidance

    • Includes mechanisms for user guidance (e.g., tooltips) to ensure a smooth user experience and to provide assistance as needed.

Deployed version of the web application ๐ŸŒ

You can access the current version of the Shiny app here.

Future hosting on eLTER service portal ๐Ÿ›ฃ๏ธ

Upon completion and thorough testing, this tool will be hosted as part of the eLTER service portal. This integration aims to provide seamless access and utility for the eLTER community. Until then, this repository serves as the primary hub for development, where updates, enhancements, and bug fixes will be continuously pushed.

Reproducibility ๐Ÿ”

This repository utilizes the renv package to manage R dependencies, ensuring that everyone working on the project has access to the same package versions. By locking the project to specific versions of R packages, renv ensures that the project can be run consistently across different setups and over time.

Getting started ๐Ÿ”ฐ

When you clone or fork this repository for the first time, follow these steps to set up renv:

  • Install renv (if you haven't already)
    • You can install renv globally in your R setup using:
install.packages("renv")
  • Clone the repository
    • Clone this repository to your local machine.
  • Launch R
    • Open an R session and set the working directory to the root of the cloned repository.
  • Restore the environment
    • Install all the necessary packages, as specified in the renv.lock file, into a project-local library by running the following command in your R console:
renv::restore()
  • Start working
    • After the restoration process is complete, you can start working on the project. The renv environment will automatically be activated when you open the project in the future.

Citation ๐Ÿ“

Souza, A. T., Ashraful Alam, S., Rasilo, T., Zacharias, S., & Bรคck, J. (2024). eLTER SO Costs web application (Version 0.1.0) [Computer software]. https://doi.org/10.5281/zenodo.10948558

Acknowledgements ๐Ÿฆ ๐Ÿ‡ช๐Ÿ‡บ

This work has been supported by the European Union's H2020 (grant agreement No 871128 - eLTER PLUS).

Related resources ๐Ÿ–‡๏ธ

  • Zacharias, S. et al. (2021). Discussion paper on eLTER Standard Observations (eLTER SOs). Deliverable D3.1 EU Horizon 2020 eLTER PLUS Project, Grant agreement No. 871128.

About

This is a repository that hosts the tool to calculate the costs of standard observations to upgrade and operate eLTER sites.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages