This repository is a collection of reproducible and reusable Viash components.
- Reusability: Facilitating the use of components across various projects and contexts.
- Reproducibility: Guaranteeing that bioinformatics analyses can be reliably replicated.
- Best Practices: Adhering to established standards in software development and bioinformatics.
We encourage contributions from the community. To contribute:
- Fork the Repository: Start by forking this repository to your account.
- Develop Your Component: Create your Viash component, ensuring it aligns with our best practices (detailed below).
- Submit a Pull Request: After testing your component, submit a pull request for review.
- Documentation of Functionality: The purpose and functionality of each component should be adequately described.
- Documentation of Inputs and Outputs: All input and output arguments should have a description and example (with extension).
- Docker Image: A Docker image (with optional additional dependencies) should be provided.
- Write unit tests: A unit test with possibly test resources needs to be provided.
- Provide test resources: If the unit test requires test resources,
these should be provided in the
test_resources
section of the component. - Versioning: If the component uses custom software (not installed
via Apt, Apk, Yum, Pip, Conda, or R), a Bash script
version.sh
needs to be provided that outputs the version of the software. - File format specifications: If a component returns a directory or data structure such as AnnData or MuData, a specification of the file format should be provided.
See the CONTRIBUTING file for more details.
…
…
For support, questions, or to join our community:
- Issues: Submit questions or issues via the GitHub issue tracker.
- Discussions: Join our discussions via GitHub Discussions.
This repository is licensed under an MIT license. See the LICENSE file for details.