Enhance PlotNado with new features, examples, and improvements#33
Merged
Conversation
- Updated index.qmd to include a new example figure using GenomicFigure. - Added a new BED file for candidate peaks in the data directory. - Introduced a register_genome function to allow users to register custom genome files. - Enhanced Bigwig and Bed aesthetics to support binning options. - Improved label positioning for BED tracks with new BedLabelPosition enum. - Added synthetic data generation functions for testing and examples. - Updated tests to cover new genome registration functionality and ensure proper error handling. - Refactored code for better readability and maintainability.
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #33 +/- ##
==========================================
- Coverage 80.62% 79.09% -1.53%
==========================================
Files 41 42 +1
Lines 5393 5554 +161
==========================================
+ Hits 4348 4393 +45
- Misses 1045 1161 +116 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request refactors the documentation and example import structure to improve clarity, maintainability, and user experience. The main changes include removing the local
docs/_examples.pyin favor of re-exporting fromplotnado.examples, updating all documentation to use the new import path, and adding a new "Worked Examples" page with real-data demos. There are also minor improvements to navigation and formatting.Documentation and Example Import Refactor:
docs/_examples.pyand replaced it with a shim that re-exports all names fromplotnado.examples, ensuring that documentation and user code share the same source of example data and functions.plotnado.examplesinstead ofdocs._examples, and added explanatory comments to code blocks for clarity. [1] [2] [3] [4] [5] [6] [7]New and Improved Documentation Content:
docs/examples.qmdpage ("Worked Examples") featuring real-data demos using public Blueprint Epigenome BigWig/BigBed files, showcasing advanced figure construction and usage._quarto.ymlfor easy access to the new page.Formatting and Navigation Tweaks:
_quarto.ymlfromfulltoarticlefor improved readability and consistency.These changes streamline the documentation, make it easier for users to find and use example code, and provide richer, real-world usage demonstrations.