# HiCShuffle
[![PyPI version](https://badge.fury.io/py/HiCShuffle.svg)](https://badge.fury.io/py/HiCShuffle)
[![DOI:10.1101/2021.09.23.459925](https://zenodo.org/badge/DOI/10.1101/2021.09.23.459925.svg)](https://doi.org/10.1101/2021.09.23.459925)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
**FASTQ Shuffling Tool For Sanity Check in Hi-C Differential Contact Analysis**
![HiCShuffle](https://hanjun.group/wp-content/uploads/2022/02/Extended-Data-Figure-X-01.png)
## Installation
```shell
pip install hicshuffle
```
## Usage
### hicshuffle <command> [options]
```shell
Commands:
diff FASTQ Shuffling Tool For Sanity Check in Hi-C Differential Contact Analysis
Run hicshuffle <command> -h for help on a specific command.
HiCShuffle: FASTQ Shuffling Tool For Sanity Check in Hi-C Differential Contact Analysis
positional arguments:
command Subcommand to run
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
```
### hicshuffle diff [-h] query_path_1 query_path_2 reference_path_1 reference_path_2 output_directory
```shell
FASTQ Shuffling Tool For Sanity Check in Hi-C Differential Contact Analysis
positional arguments:
query_path_1 Path for READ1 of GZ-Compressed or Uncompressed Query FASTQ
query_path_2 Path for READ2 of GZ-Compressed or Uncompressed Query FASTQ
reference_path_1 Path for READ1 of GZ-Compressed or Uncompressed Reference FASTQ
reference_path_2 Path for READ2 of GZ-Compressed or Uncompressed Reference FASTQ
output_directory Output Directory... HiCShuffle Will Generate Output Directory If Not Existent
optional arguments:
-h, --help show this help message and exit
```
Raw data
{
"_id": null,
"home_page": "https://github.com/hanjunlee21/HiCShuffle",
"name": "HiCShuffle",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "hi-c,qc",
"author": "Hanjun Lee",
"author_email": "hanjun@mit.edu",
"download_url": "https://files.pythonhosted.org/packages/52/c8/ec53429714f540beb14580bc1a89cd899f84dea067597b3945d53f32ba79/HiCShuffle-1.1.2.tar.gz",
"platform": null,
"description": "# HiCShuffle\n\n[![PyPI version](https://badge.fury.io/py/HiCShuffle.svg)](https://badge.fury.io/py/HiCShuffle)\n[![DOI:10.1101/2021.09.23.459925](https://zenodo.org/badge/DOI/10.1101/2021.09.23.459925.svg)](https://doi.org/10.1101/2021.09.23.459925)\n[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)\n\n**FASTQ Shuffling Tool For Sanity Check in Hi-C Differential Contact Analysis**\n\n![HiCShuffle](https://hanjun.group/wp-content/uploads/2022/02/Extended-Data-Figure-X-01.png)\n\n## Installation\n```shell\npip install hicshuffle\n```\n\n## Usage\n\n### hicshuffle <command> [options]\n\n```shell\nCommands:\n diff FASTQ Shuffling Tool For Sanity Check in Hi-C Differential Contact Analysis\nRun hicshuffle <command> -h for help on a specific command.\n\nHiCShuffle: FASTQ Shuffling Tool For Sanity Check in Hi-C Differential Contact Analysis\n\npositional arguments:\n command Subcommand to run\n\noptional arguments:\n -h, --help show this help message and exit\n --version show program's version number and exit\n```\n\n### hicshuffle diff [-h] query_path_1 query_path_2 reference_path_1 reference_path_2 output_directory\n\n```shell\n\nFASTQ Shuffling Tool For Sanity Check in Hi-C Differential Contact Analysis\n\npositional arguments:\n query_path_1 Path for READ1 of GZ-Compressed or Uncompressed Query FASTQ\n query_path_2 Path for READ2 of GZ-Compressed or Uncompressed Query FASTQ\n reference_path_1 Path for READ1 of GZ-Compressed or Uncompressed Reference FASTQ\n reference_path_2 Path for READ2 of GZ-Compressed or Uncompressed Reference FASTQ\n output_directory Output Directory... HiCShuffle Will Generate Output Directory If Not Existent\n\noptional arguments:\n -h, --help show this help message and exit\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "FASTQ Shuffling Tool For Sanity Check in Hi-C Differential Contact Analysis",
"version": "1.1.2",
"project_urls": {
"Download": "https://github.com/hanjunlee21/HiCShuffle/archive/refs/tags/v.1.1.2.tar.gz",
"Homepage": "https://github.com/hanjunlee21/HiCShuffle"
},
"split_keywords": [
"hi-c",
"qc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52c8ec53429714f540beb14580bc1a89cd899f84dea067597b3945d53f32ba79",
"md5": "a5c698368447e2c3e93aa5d6d457ac3e",
"sha256": "d8c27951165e31fc141460f923ca95660e85fcb7f23e3896ec400b92fb3875d6"
},
"downloads": -1,
"filename": "HiCShuffle-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "a5c698368447e2c3e93aa5d6d457ac3e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4698,
"upload_time": "2023-12-08T21:50:32",
"upload_time_iso_8601": "2023-12-08T21:50:32.530064Z",
"url": "https://files.pythonhosted.org/packages/52/c8/ec53429714f540beb14580bc1a89cd899f84dea067597b3945d53f32ba79/HiCShuffle-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 21:50:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hanjunlee21",
"github_project": "HiCShuffle",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hicshuffle"
}