Skip to content

STOPeData is a data entry and formatting Shiny app in the Source to Outcome Pathway family, designed to make extracting data on chemical concentrations in the environment from papers and reports easier.

License

Notifications You must be signed in to change notification settings

NIVANorge/STOPeData

Repository files navigation


Logo

STOP Exposure Data App

STOPeData is a data entry and formatting Shiny app in the Source to Outcome Pathway/Risk assessment database family, designed to make extracting data on chemical concentrations in the environment from papers and reports easier.

View Test Version (requires NIVA account) · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contact
  6. Acknowledgments

About The Project

workflow

This app designed to guide users through the formatting, cleaning and annotation of exposure/pollution/monitoring data (e.g. mg/L of a chemical in an environmental matrix). Published studies and reports are an important source of this data, but it is often fragmented and difficult to analyse without extensive data cleaning and transformation. By assisting and automating this step, we hope to make exposure assessment - and therefore the risk assessment of chemicals in the environment - as easy as possible.

This app is part of the Source to Outcome Pathway/Risk assessment database family of R Shiny apps, and provides one-half of the data necessary for environmental risk assessment. Its counterpart for toxicity/bioassay data is STOP qData. Environmental risk predictions can be viewed at the Source To Outcome Predictor.

(back to top)

Built With

R

R-CMD-check

(back to top)

Getting Started

I haven't tested setting the app up to run locally on systems other than my home PC. It should work following the below instructions, although it depends on quite a lot of R packages which you will have to download. In general, I recommend

Prerequisites

  • R version 4.5.2
  • Various R packages (see MANIFEST)

Installation

  1. (Optional) Get an Anthropic API key for LLM data extraction
  2. Clone the repo
    git clone https://github.com/sawelch-NIVA/STOPeData.git
  3. Install NPM packages
    npm install
  4. (Optional) Enter your API in your .Renviron file
    ANTHROPIC_API_KEY = 'sk-ant-api03-...';
  5. Change git remote url to avoid accidental pushes to base project
    git remote set-url origin sawelch-NIVA/STOPeData
    git remote -v # confirm the changes
  6. Run app locally:
    golem::run_dev()

(back to top)

Usage

This version of the app demo is hosted on Posit Connect Cloud on my personal account: https://sawelch-niva-stopedata.share.connect.posit.cloud/. This will be migrated to NIVA's standard severs when practical.

Screenshots and Diagrams

complicated_workflow An overview of the manual/LLM assisted workflow.

sites Entering data on sampling sites.

biota Entering data about sampled organisms.

creed Assisted assessment of data quality using the CREED framework.

(back to top)

Roadmap

  • Better test architecture and general bug fixes
  • More user-friendly session saving
  • Data extraction from structured formats (e.g. Excel spreadsheets, API calls)
  • Connection to the Risk Assessment database for lookups and long-term storage
  • Support for more formats

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Sam Welch - sam.welch@niva.no

Project Link: https://github.com/NIVANorge/STOPeData

(back to top)

Acknowledgments

  • Project Lead: Knut Erik Tollefsen
  • Funding: EXPECT, PARC, and NCTP Projects
  • Testers: Li Xi, Knut Erik Tollefsen, Sophie Mentzel, Pierre Blévin, Camden Karon Klefbom
  • Support and Advice: Viviane Giradin, Andrea Merlina, Kim Leirvik, Jemmima Knight, Malcolm Reid
  • An LLM (Anthropic Claude Sonnet 4.5) was used in the creation of this app and its code.
  • Readme template repo: Best-README-Template
  • (If I've left you off please let me know!)

(back to top)

About

STOPeData is a data entry and formatting Shiny app in the Source to Outcome Pathway family, designed to make extracting data on chemical concentrations in the environment from papers and reports easier.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages