FloraExam is an R package built with the {golem} framework that provides a Shiny application to explore, score, and visualize Danish flora and vegetation types. This repository hosts both the code for the FloraExam R package and the Docker configuration that allows seamless deployment.
- Overview
- Features
- Installation
- Running the App
- Data Sources
- Dependencies
- Live Demo
- Contributing
- License
- Acknowledgments
FloraExam is designed to help students:
- Examine flora data with user-friendly Shiny dashboards.
- Utilize ecological scoring systems (e.g., CSR values, Ellenberg indicator values).
- Assess species frequency and spatial information.
This application leverages multiple datasets and the companion Artscore package to provide integrated analysis and visualization tools.
Note: A public instance of this app is available at DanishVegetationTypes.
- Interactive Shiny App: Built using
{golem}
for modular and maintainable Shiny code. - Ecological Scoring: Integrates Ellenberg and CSR values for species analysis.
- Frequency and Spatial Data: Includes frequency data and spatial distributions of species.
- Easy Deployment: Automated Docker builds for easy deployment on Azure or any other containerized environment.
You can install FloraExam from GitHub. Before installing, ensure you have the remotes package installed.
# install.packages("remotes") # If not already installed
# Install FloraExam directly from GitHub
remotes::install_github("Sustainscapes/FloraExam")
This will also install the FloraExam R package dependencies automatically.
Once FloraExam is installed, you can launch the Shiny app locally:
library(FloraExam)
run_app()
The app will open in your default web browser.
This repository includes a Dockerfile that is automatically rebuilt on every push to GitHub. To run FloraExam via Docker:
-
Clone this repository or pull the public image (if available).
-
Build the Docker image:
docker build -t floraexam .
-
Run the Docker container:
docker run --rm -p 3838:3838 floraexam
-
Open your web browser at http://localhost:3838 to access the app.
FloraExam relies on several data sources for its functionality:
-
Ellenberg_CSR dataset
-
Final_Frequency and SpatialData datasets
-
artscore
- Artscore provides scoring functions for ecological analyses used within FloraExam.
These datasets and the artscore package are automatically installed or fetched when you install and run FloraExam (provided you have internet access).
The main additional dependency used by FloraExam is:
- Artscore: An R package for ecological scoring and analysis.
All other dependencies (R packages) can be found in the DESCRIPTION
file within this repo.
The artscore package is developed by Sustainscapes. It includes key functions for calculating ecological indices, scoring species, and more. FloraExam integrates with artscore to enhance your ecological analysis workflow.
A live version of FloraExam is hosted at:
DanishVegetationTypes
Feel free to explore and interact with the app to see what FloraExam can do!
We welcome contributions to improve FloraExam. Here’s how you can help:
- Fork the repository on GitHub.
- Create a new branch for your changes.
- Commit and push your changes to your branch.
- Submit a Pull Request describing your changes.
Please ensure your code meets our style guidelines and includes unit tests where necessary.
This project is licensed under the terms of the MIT License. You are free to use, modify, and distribute this software.
We extend our thanks to all contributors and the open-source community who make projects like FloraExam possible. Special thanks to:
- Sustainscapes for developing FloraExam and the artscore package.
- The authors and maintainers of the various data repositories integrated into FloraExam.
For any questions or issues, please open an issue or contact us directly.