vuecore 0.1.1

A Python package for creating interactive and static visualizations of multi-omics data

VueCore is a Python package for creating interactive and static visualizations of multi-omics data

Information	Links
Package
Documentation
Build
Discuss on GitHub

Table of contents:

• About the project
• Installation
• Documentation
• License
• Contributing
• Credits and acknowledgements
• Contact and feedback

About the project

VueCore is part of a broader ecosystem of tools for multi-omics analysis, working in conjunction with ACore and VueGen to enable end-to-end data processing, visualization, and reporting.

Installation

[!TIP] It is recommended to install VueCore inside a virtual environment to manage depenendencies and avoid conflicts with existing packages. You can use the virtual environment manager of your choice, such as poetry, conda, or pipenv.

Pip

VueCore is available on PyPI and can be installed using pip:

pip install vuecore

You can also install the package for development by cloning this repository and running the following command:

[!WARNING] We assume you are in the root directory of the cloned repository when running this command. Otherwise, you need to specify the path to the vuecore directory.

pip install -e .

Documentation

VueCore's documentation is hosted on Read the Docs. It includes detailed examples for every plot type, configuration options, and the API reference. It is designed to help you with creating visualizations for your multi-omics data.

License

The code in this repository is licensed under the MIT License, allowing you to use, modify, and distribute it freely as long as you include the original copyright and license notice.

The documentation and other creative content are licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License, meaning you are free to share and adapt it with proper attribution.

Full details for both licenses can be found in the LICENSE file.

Contributing

VueCore is an open-source project, and we welcome contributions of all kinds via GitHub issues and pull requests. You can report bugs, suggest improvements, propose new features, or implement changes.

We follow the Conventional Commits specification for commit messages and use the changelog-from-release tool to automatically generate the CHANGELOG.

Please follow the guidelines in the CONTRIBUTING file to ensure that your contribution is easily integrated into the project.

Credits and acknowledgements

• VueCore was developed by the Multiomics Network Analytics Group (MoNA) at the Novo Nordisk Foundation Center for Biosustainability (DTU Biosustain).

Contact and feedback

We appreciate your feedback! If you have any comments, suggestions, or run into issues while using VueCore, feel free to open an issue in this repository. Your input helps us make VueCore better for everyone.