In cdsanchez18/EcoPLOT: EcoPLOT: dynamic and interactive analysis of multivariate biogeochemical datasets

Contributing to EcoPLOT

The EcoPLOT development team encourages user input. These topics include, but are not limited to,

• Reporting a bug
• Discussing the current state of the platform and its code
• Submitting a fix
• Proposing new software or analytical technique
• Becoming a maintainer

We Develop With GitHub

We use GitHub to host our platform and its code, to track issues or bugs, and to accept pull requests from members of the community.

We Use The GitHub Flow Model To Propose Changes To The Codebase

We provide an overview of this workflow below:

1. Fork the EcoPLOT repository and create your own branch.
2. Ensure your commits and their associated commit messages are clear.
3. Ensure you have provided tests for your code and that they pass said tests.
• For more information on writing tests in R, please consult this link.
4. Proofread your code against the EcoPLOT style guidelines (see below).
5. When the above steps are completed, you are ready to make your Pull Request!

Code Linting/ Style Guide

TThe EcoPLOT development team follows the Tidyverse Style Guide when writing code. When proposing new additions or when submitting improved code, we ask that you please follow the guidelines of the style guide above. Before submission, please utilize the styler package to automatically style your code. For a demonstration on how to utlize the styler package, please consult the demos on their website.

Reporting Bugs Using GitHub Issues

The EcoPLOT team uses GitHub Issues to track public bugs. To submit a new bug, simply create a new issue by opening one.

When submitting a bug please include a report that contains the following:

• A summary of the issue
• Steps taken prior to the issue
• Provide sample code if possible or identify where in the codebase this error can be found.
• What you expected to happen versus what actually happened
• Specificity is key when reporting bug issues

Reporting New Features/Novel Analytical Techniques With Commit Notes

We understand that R is a popular language used by researchers and we encourage all to propose new analytical techniques, workflows, or additional features. We encourage this to be done through pull requests.

Please include a commit note that includes the following:

• A comphrehensive summary of the feature/workflow being proposed
• An explanation of the utility of this tool to the exisitng platform
• A list of the packages it requires, if not already included in EcoPLOT
• Any publications that describe the technique, if any

Acknowledging the License

EcoPLOT is operated under the MIT license. By submitting any changes to the codebase, you acknowledge that your submissions will be under the same license that covers the EcoPLOT platform. If you have any questions or concerns, feel free to reach out to [e-mail]

A Note on Coding Style and App Structure

EcoPLOT is organized into four modules, Environment, Phenotype, Microbiome, and IRF. Within each modules are various components that correspond to stages along the workflow. We ask that users continue to separate code by module and component in order to reduce line count and improve organization.

Hosting EcoPLOT on a Server

At this time EcoPLOT is not hosted on a server and must be run locally on your personal device. The development team has discussed potentially hosting EcoPLOT on the web via Shiny Servers. If you are interested in hosting and managing a version of EcoPLOT on your own server, please contact [e-mail] for more information.

References

This guide is adapted from the open-source contribution guidelines for Facebook Open Source

cdsanchez18/EcoPLOT documentation built on Feb. 21, 2022, 2:08 p.m.