From 43c55cdb2337fedfe2625603a9011ee9456ba24b Mon Sep 17 00:00:00 2001 From: emunozdc Date: Wed, 19 Jun 2024 23:05:58 +0200 Subject: [PATCH] Update version 0.0.25. --- .github/workflows/continuous_integration.yml | 2 +- README.md | 31 ++++++++++---------- docs/requirements.txt | 2 +- setup.py | 2 +- src/pyranges_plot/_version.py | 2 +- 5 files changed, 19 insertions(+), 20 deletions(-) diff --git a/.github/workflows/continuous_integration.yml b/.github/workflows/continuous_integration.yml index bf0f784..23db1a1 100644 --- a/.github/workflows/continuous_integration.yml +++ b/.github/workflows/continuous_integration.yml @@ -21,7 +21,7 @@ jobs: - name: Install dependencies run: | # I am using the pip installed by conda, bad practice but OK in C/I I think - pip install pyranges-plot[all]==0.0.24 + pip install pyranges-plot[all]==0.0.25 pip install ruff pytest - name: Check formatting with ruff run: | diff --git a/README.md b/README.md index 2f76810..ae41f4a 100644 --- a/README.md +++ b/README.md @@ -8,24 +8,23 @@ Gene visualization package for dataframe objects generated with [PyRanges](https The goal is getting a plot displaying a series of genes, transcripts, or any kind of ranges contained in a PyRanges object. It displays the genes' intron-exon structure in its corresponding chromosome, enabling easy visualization of your PyRanges data. The -Pyranges version compatible with Pyranges Plot is >= 1.0.0. +Pyranges version compatible with Pyranges Plot is >= 1.0.0 (find it at https://github.com/pyranges/pyranges_1.x.git). To obtain the plot there are some features to be defined by the user, one is the -**engine** since it can be based on Matplotlib or Plotly, the other is the name -of the **gene ID** column in your data. The rest of features can either be left -as default or be customized. In example, the plot shows the first 25 genes of the -dataframe by default, but this can be modified. It is worth noting that the order -of the genes will be conserved when performing the subset. +**engine** since it can be based on Matplotlib or Plotly, the other is optional and +refers to the name of the **gene ID** column in your data. The rest of features can +either be left as default or be customized. In example, the plot shows the first 25 +genes of the dataframe by default, but this can be modified. In the case of coloring, Pyranges Plot offers a wide versatility. The data feature (column) according to which the genes will be colored is by default the gene ID, but this "color column" can be selected manually. Color specifications can be left as the -default colormap (``plotly.colors.qualitative.Alphabet``) or be provided as dictionaries, -lists or color objects from either Matplotlib or Plotly regardless of the chosen engine. -When a colormap or list of colors is specified, the colors assigned to the genes will -iterate over the provided ones following the color column pattern. In the case of -concrete color instructions such as dictionary, the genes will be colored according -to it while the non-specified ones will be colored in black. +default colormap or be provided as dictionaries, lists or color objects from either +Matplotlib or Plotly regardless of the chosen engine. When a colormap or list of colors +is specified, the colors assigned to the genes will iterate over the provided ones +following the color column pattern. In the case of concrete color instructions such as +dictionary, the genes will be colored according to it while the non-specified ones will +be colored in black.

@@ -36,15 +35,15 @@ to it while the non-specified ones will be colored in black. ## Installation PyRanges-Plot can be installed using pip. To install all dependencies in order to be able to -use all the functionalities of the package and both engines the `[all]` option must be +use all the functionalities of the package and both engines, the `[all]` option must be specified: ``` pip install pyranges-plot[all] ``` -If the user wishes to use only one of the engines, the installation af all dependencies -can be avoided by using the engine-specific installation option: +If the user wishes to use only one of the engines, the installation of all dependencies +can be avoided by using the engine-specific installation options: ``` # For matplotlib pip install pyranges-plot[plt] @@ -54,7 +53,7 @@ pip install pyranges-plot[plotly] ``` Note that the minimal installation by `pip install pyranges-plot` is not able to produce plots -since the plot dependencies are not installed. +since the graphical dependencies are not installed. ## Documentation diff --git a/docs/requirements.txt b/docs/requirements.txt index f8c6ce9..215c252 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -pyranges_plot==0.0.24 +pyranges_plot==0.0.25 Sphinx==7.3.7 sphinx-rtd-theme==2.0.0 sphinx-autoapi==3.0.0 diff --git a/setup.py b/setup.py index 3b02cc7..9e3775f 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ setup( name="pyranges_plot", - version="0.0.24", + version="0.0.25", packages=find_packages(where="src"), package_dir={"": "src"}, ) diff --git a/src/pyranges_plot/_version.py b/src/pyranges_plot/_version.py index 5681085..5a6b518 100644 --- a/src/pyranges_plot/_version.py +++ b/src/pyranges_plot/_version.py @@ -1 +1 @@ -__version__ = "0.0.24" +__version__ = "0.0.25"