bw-merge-window


Namebw-merge-window JSON
Version 0.2.0 PyPI version JSON
download
home_page
SummaryA python extension for quick access to bigWig and bigBed files.
upload_time2024-01-04 16:11:29
maintainer
docs_urlNone
authorDavid Lougheed
requires_python>=3.10,<4.0
licenseGPL-3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # bw-merge-window

[![PyPI version](https://badge.fury.io/py/bw-merge-window.svg)](https://badge.fury.io/py/bw-merge-window)
[![codecov](https://codecov.io/gh/c3g/bw-merge-window/graph/badge.svg?token=HU9UTAASQG)](https://codecov.io/gh/c3g/bw-merge-window)

A command-line utility for merging and averaging a window of a set of bigWigs, inspired by/tested against the previous 
C3G `bigWigMergePlus` tool developed by Romain Grégoire.

This is part of the core set of tools that powers the [EpiVar Browser](https://github.com/c3g/epivar-browser).

**Requires:** Python 3.10+


## License

Everything in this repository **EXCEPT FOR EVERYTHING** under the `tests/bin` and `tests/data` directories is licensed 
under the terms of the [GNU General Public License, v3.0](./LICENSE). 

&copy; McGill University 2023

Everything under the `tests/bin` directory is &copy; UCSC. Everything under the `tests/data` directory is from the
IHEC Epigenomes portal and the copyright is retained by the relevant holders.


## Installation

```bash
pip install bw-merge-window
```


## Usage

```bash
bw-merge-window chr1:100000-200000 file1.bw file2.bw --output average.bw [--range 0-1000] [--treat-missing-as-zero]
```

If the optional flag `--treat-missing-as-zero` is passed, `N/A` values in bigWigs become 0, and any 0-values in the
merged file will not be written. Otherwise, if a value is missing in one or more of the files, it'll be missing in the
merged file as well. This flag is **required** if you want full backwards-compatibility with `bigWigMergePlus`.

If you want to include a negative value for `--range`, use "equals" syntax instead, e.g., `--range='-500-1000'`.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "bw-merge-window",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "David Lougheed",
    "author_email": "david.lougheed@mail.mcgill.ca",
    "download_url": "https://files.pythonhosted.org/packages/58/9c/d04337635e3e3d02be7b5cba44051a368ad5337246b86e0b746e0f9f6efc/bw_merge_window-0.2.0.tar.gz",
    "platform": null,
    "description": "# bw-merge-window\n\n[![PyPI version](https://badge.fury.io/py/bw-merge-window.svg)](https://badge.fury.io/py/bw-merge-window)\n[![codecov](https://codecov.io/gh/c3g/bw-merge-window/graph/badge.svg?token=HU9UTAASQG)](https://codecov.io/gh/c3g/bw-merge-window)\n\nA command-line utility for merging and averaging a window of a set of bigWigs, inspired by/tested against the previous \nC3G `bigWigMergePlus` tool developed by Romain Gr\u00e9goire.\n\nThis is part of the core set of tools that powers the [EpiVar Browser](https://github.com/c3g/epivar-browser).\n\n**Requires:** Python 3.10+\n\n\n## License\n\nEverything in this repository **EXCEPT FOR EVERYTHING** under the `tests/bin` and `tests/data` directories is licensed \nunder the terms of the [GNU General Public License, v3.0](./LICENSE). \n\n&copy; McGill University 2023\n\nEverything under the `tests/bin` directory is &copy; UCSC. Everything under the `tests/data` directory is from the\nIHEC Epigenomes portal and the copyright is retained by the relevant holders.\n\n\n## Installation\n\n```bash\npip install bw-merge-window\n```\n\n\n## Usage\n\n```bash\nbw-merge-window chr1:100000-200000 file1.bw file2.bw --output average.bw [--range 0-1000] [--treat-missing-as-zero]\n```\n\nIf the optional flag `--treat-missing-as-zero` is passed, `N/A` values in bigWigs become 0, and any 0-values in the\nmerged file will not be written. Otherwise, if a value is missing in one or more of the files, it'll be missing in the\nmerged file as well. This flag is **required** if you want full backwards-compatibility with `bigWigMergePlus`.\n\nIf you want to include a negative value for `--range`, use \"equals\" syntax instead, e.g., `--range='-500-1000'`.\n\n",
    "bugtrack_url": null,
    "license": "GPL-3.0",
    "summary": "A python extension for quick access to bigWig and bigBed files.",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0900d97c9c7cfa4f9a3b9b8dfd50cfd90abf2715b5c7682e70eef69c6175196b",
                "md5": "96e203ddbabf0fab9139d1879dfefd84",
                "sha256": "84089cf5a06117cc9ef13ddcdb6c3dfff3be07d020ccceb1dbfd078601e6e73a"
            },
            "downloads": -1,
            "filename": "bw_merge_window-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "96e203ddbabf0fab9139d1879dfefd84",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 18242,
            "upload_time": "2024-01-04T16:11:28",
            "upload_time_iso_8601": "2024-01-04T16:11:28.097349Z",
            "url": "https://files.pythonhosted.org/packages/09/00/d97c9c7cfa4f9a3b9b8dfd50cfd90abf2715b5c7682e70eef69c6175196b/bw_merge_window-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "589cd04337635e3e3d02be7b5cba44051a368ad5337246b86e0b746e0f9f6efc",
                "md5": "4e98a8add8ffe5d31ff1f8f75d4b9b36",
                "sha256": "1973b9e51ad28f7bbae76f7abdc90e29dc0188c356684e1634878501d14eb894"
            },
            "downloads": -1,
            "filename": "bw_merge_window-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4e98a8add8ffe5d31ff1f8f75d4b9b36",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 16816,
            "upload_time": "2024-01-04T16:11:29",
            "upload_time_iso_8601": "2024-01-04T16:11:29.429740Z",
            "url": "https://files.pythonhosted.org/packages/58/9c/d04337635e3e3d02be7b5cba44051a368ad5337246b86e0b746e0f9f6efc/bw_merge_window-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-04 16:11:29",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "bw-merge-window"
}
        
Elapsed time: 0.40234s