Skip to content

emmarousseau/biobox

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

81468c3 · Apr 3, 2024

History

40 Commits
Feb 26, 2024
Feb 26, 2024
Apr 3, 2024
Jan 26, 2024
Apr 3, 2024
Mar 19, 2024
Jan 18, 2024
Jan 18, 2024
Jan 18, 2024
Feb 27, 2024

Repository files navigation

Base repository for reusable Viash components

This repository is a collection of reproducible and reusable Viash components.

Objectives

  • 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.

Contributing

We encourage contributions from the community. To contribute:

  1. Fork the Repository: Start by forking this repository to your account.
  2. Develop Your Component: Create your Viash component, ensuring it aligns with our best practices (detailed below).
  3. Submit a Pull Request: After testing your component, submit a pull request for review.

Contribution Guidelines

  • 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.

Repository Structure

Installation and Usage

Support and Community

For support, questions, or to join our community:

License

This repository is licensed under an MIT license. See the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 79.4%
  • Python 14.4%
  • Roff 2.1%
  • R 2.1%
  • Common Workflow Language 2.0%