divan is intended to aid researchers and students in performing exploratory functional diversity (FD) analyses. The layout is based on the steps 3-7 proposed in Palacio et al. (2022), and works mainly as an exploration and interactive data tool. To perform a rigorous functional diversity data analysis, we suggest the user referring to several packages already available.
To use this app locally, follow these steps:
- Clone the repository:
git clone https://github.com/facuxpalacio/divan.git
- Install required packages
# Navigate to the app directory
setwd("divan")
# Install necessary R packages
install.packages(c("shiny", "other_required_packages"))
Usage To run the app, open the app.R file in RStudio and click on the 'Run App' button. Alternatively, you can run the following command in your R environment:
# Load the Shiny library
library(shiny)
# Run the app
shiny::runApp()
Automated tests have been implemented to ensure the functionality of this app. To run the tests:
Navigate to the tests/ directory. Execute the test suite using your preferred testing framework.
R/app.R: Contains the main Shiny app code.
data/: Stores any necessary datasets or files.
Contributions are welcome! If you want to improve the app or fix any issues, please take a moment to review these guidelines before getting started.
- Fork the repository.
- Create a new branch for your contributions.
- Make changes, enhancements, or bug fixes.
- Test your changes thoroughly.
- Submit a pull request.
Please follow the established code style and standards used in the project. If there are no specific guidelines, try to match the existing coding style.
If you encounter any issues or have feature requests, please open an issue in the repository. Provide as much detail as possible to help us understand and address the problem.
When submitting a pull request:
- Provide a clear description of the changes made.
- Reference any related issues.
- Ensure your code is well-tested and doesn't introduce new issues.
- Follow the project's coding conventions.
For any questions or discussions, use the issue tracker or the specified communication channels.
The web-based application is entirely based on Shiny, an open source R package (R 4.2.3, R Core Team 2023). The full list and version of each R package used can be found in the code available at https://github.com/facuxpalacio/divan/tree/main/R - see the LICENSE file for details.
If you have any questions or suggestions, feel free to contact Facundo X. Palacio at [email protected].