Skip to content

Commit

Permalink
Update version 0.0.25.
Browse files Browse the repository at this point in the history
  • Loading branch information
emunozdc authored and emunozdc committed Jun 19, 2024
1 parent 52fbf73 commit 43c55cd
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/continuous_integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<p align="center">
<img src="https://github.com/emunozdc/pyranges_plot/raw/main/images/general_ex.png">
Expand All @@ -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]
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name="pyranges_plot",
version="0.0.24",
version="0.0.25",
packages=find_packages(where="src"),
package_dir={"": "src"},
)
2 changes: 1 addition & 1 deletion src/pyranges_plot/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.0.24"
__version__ = "0.0.25"

0 comments on commit 43c55cd

Please sign in to comment.