{ "info": { "author": "Laurent Modolo", "author_email": "laurent.modolo@ens-lyon.fr", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# IDR\n\nThis tool is designed to compute the Irreproducible Discovery Rate (IDR)\nfrom NarrowPeaks files for two or more replicates.\nIt\u2019s an implementation of the method described in the following paper using\nGaussian copula.\n\n> LI, Qunhua, BROWN, James B., HUANG, Haiyan, et al. Measuring reproducibility\n> of high-throughput experiments. The annals of applied statistics, 2011,\n> vol. 5, no 3, p. 1752-1779.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your\nlocal machine for development and testing purposes.\n\n### Prerequisites\n\nTo run **midr** on your computer you need to have python (>= 3) installed.\n\n```sh\npython3 --version\n```\n\n### Installing\n\nTo easily install **midr** on your computer using `pip` run the following command:\n\n```\npip3 install midr\n```\n\nOtherwise you can clone this repository:\n\n```\ngit clone https://github.com/LBMC/midr.git\ncd midr/src/\npython3 setup.py install\n```\n\nGiven a list of peak calls in NarrowPeaks format and the corresponding peak\ncall for the merged replicate. This tool computes and appends a IDR column to\nNarrowPeaks files.\n\n### Dependencies\n\nThe **idr** package depends on the following python3 library:\n\n- [scipy>=1.3](https://scipy.org) [DOI:10.1109/MCSE.2007.58](https://doi.org/10.1109/MCSE.2007.58) [DOI:10.1109/MCSE.2011.36](https://doi.org/10.1109/MCSE.2011.36)\n\n> Travis E. Oliphant. Python for Scientific Computing, Computing in Science &\n> Engineering, 9, 10-20 (2007), DOI:10.1109/MCSE.2007.58\n\n> K. Jarrod Millman and Michael Aivazis. Python for Scientists and Engineers,\n> Computing in Science & Engineering, 13, 9-12 (2011),\n> DOI:10.1109/MCSE.2011.36\n\n\n- [numpy>=1.16](https://numpy.org/) [DOI:10.1109/MCSE.2011.37](https://doi.org/10.1109/MCSE.2010.118)\n\n> Travis E, Oliphant. A guide to NumPy, USA: Trelgol Publishing, (2006).\n\n> St\u00e9fan van der Walt, S. Chris Colbert and Ga\u00ebl Varoquaux. The NumPy Array:\n> A Structure for Efficient Numerical Computation, Computing in Science &\n> Engineering, 13, 22-30 (2011), DOI:10.1109/MCSE.2011.37\n\n- [matplotlib>=3.1](https://github.com/matplotlib/matplotlib/tree/v3.1.1) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3264781.svg)](https://doi.org/10.5281/zenodo.3264781)\n\n> J. D. Hunter, \"Matplotlib: A 2D Graphics Environment\",\n> Computing in Science & Engineering, vol. 9, no. 3, pp. 90-95, 2007.\n\n- [pandas>=0.25.0](https://pandas.pydata.org)\n> McKinney. Data Structures for Statistical Computing in Python, Proceedings\n> of the 9th Python in Science Conference, 51-56 (2010) [(publisher link)](http://conference.scipy.org/proceedings/scipy2010/mckinney.html)\n\n- [pynverse>=0.1](https://pypi.org/project/pynverse/)\n\n## Usage\n\n**idr** Takes as input file in the [NarrowPeaks format](https://genome.ucsc.edu/FAQ/FAQformat.html#format12),\nand output NarrowPeaks files with an additional *idr* column.\n\nComputing *IDR* between three replicates\n\n```\n$ midr -m merged_peak_calling.NarrowPeaks \\\n -f replicate1_.NarrowPeaks replicate2.NarrowPeaks replicate3.NarrowPeaks \\\n -o results\n```\n\nWhere `replicate1_.NarrowPeaks` is the output of the peak caller on the \nalignment file corresponding to the first replicate and \n`merged_peak_calling.NarrowPeaks` is the output of the peak caller on the merge\nof the replicates alignment files.\n`Results` are the directory where we want to output our results.\n\nDisplaying help:\n\n```\n$ midr -h\nusage: midr [-h] --merged FILE --files FILES [FILES ...] [--output DIR] \n [--score SCORE_COLUMN] [--threshold THRESHOLD] [--debug] \n [--verbose] \n\nCompute the Irreproducible Discovery Rate (IDR) from NarrowPeaks files \n\nImplementation of the IDR methods for two or more replicates. \n\nLI, Qunhua, BROWN, James B., HUANG, Haiyan, et al. Measuring reproducibility \nof high-throughput experiments. The annals of applied statistics, 2011, \nvol. 5, no 3, p. 1752-1779. \n\nGiven a list of peak calls in NarrowPeaks format and the corresponding peak \ncall for the merged replicate. This tool computes and appends a IDR column to \nNarrowPeaks files. \n\noptional arguments: \n -h, --help show this help message and exit \n\nIDR settings: \n --merged FILE, -m FILE \n file of the merged NarrowPeaks \n --files FILES [FILES ...], -f FILES [FILES ...] \n list of NarrowPeaks files \n --output DIR, -o DIR output directory (default: results) \n --score SCORE_COLUMN, -s SCORE_COLUMN \n NarrowPeaks score column to compute the IDR on, one of\n 'score', 'signalValue', 'pValue' or 'qValue' (default:\n signalValue) \n --threshold THRESHOLD, -t THRESHOLD \n Threshold value for the precision of the estimator \n (default: 0.01) \n --debug, -d enable debugging (default: False) \n --verbose log to console (default: False) \n```\n\n\n## Authors\n\n* **Laurent Modolo** - *Initial work*\n\n## License\n\nThis project is licensed under the CeCiLL License- see the [LICENSE](LICENSE) file for details.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/LBMC/midr", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "midr", "package_url": "https://pypi.org/project/midr/", "platform": "", "project_url": "https://pypi.org/project/midr/", "project_urls": { "Homepage": "https://github.com/LBMC/midr" }, "release_url": "https://pypi.org/project/midr/1.0.5/", "requires_dist": [ "scipy (>=1.3)", "numpy (>=1.16)", "pynverse (>=0.1)", "pandas (>=0.25.0)", "matplotlib (>=3.1)" ], "requires_python": "", "summary": "Compute idr from m NarrowPeak files and a merged NarrowPeak", "version": "1.0.5" }, "last_serial": 5787270, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "33216dcf97872c9b31efc1ea42e546fb", "sha256": "c4111e735d5aefab49cca3cc5a62a28f5d76de3663c89f33922eb544a500bbd5" }, "downloads": -1, "filename": "midr-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "33216dcf97872c9b31efc1ea42e546fb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10481, "upload_time": "2019-09-05T11:54:42", "url": "https://files.pythonhosted.org/packages/3d/b3/74b8c9c9b3cb7974742bac3cf8a70fa006afd916478cccddd38d2b0fe724/midr-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "386fc73546e4e6f86a890d8d7272f91e", "sha256": "2087fff2712201adbd055de1fa600dfde737c4ea12361ba927fc84f2658e4cc4" }, "downloads": -1, "filename": "midr-1.0.1.tar.gz", "has_sig": false, "md5_digest": "386fc73546e4e6f86a890d8d7272f91e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11469, "upload_time": "2019-09-05T11:54:44", "url": "https://files.pythonhosted.org/packages/d3/6a/0ff96de1818d927a480ef1aa4e6f477f805c74d675e61aa4a31bdbea8890/midr-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "337a7089ac418df68a9397e6a400855a", "sha256": "c0a16009dcea28350c4766637eca54a76c67f063f187524587c3410b989a5f5b" }, "downloads": -1, "filename": "midr-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "337a7089ac418df68a9397e6a400855a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10593, "upload_time": "2019-09-05T14:21:19", "url": "https://files.pythonhosted.org/packages/27/48/21a1835bb09113829919edaac854d61ade422b58f09d30e31c2a7d5d4c34/midr-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e067df81894476620284bcdba05216ba", "sha256": "d2ac51dce43d8c00ac46137ca5125e3b1645b9526197afec3594dfcb890e1ddb" }, "downloads": -1, "filename": "midr-1.0.2.tar.gz", "has_sig": false, "md5_digest": "e067df81894476620284bcdba05216ba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11598, "upload_time": "2019-09-05T14:21:22", "url": "https://files.pythonhosted.org/packages/39/72/d5299714fd5e5f32581c9cfac51ec0997343afc3b47e53df3b774cfe2455/midr-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "581aef3cdd6b30e11f27d3992e6e5cce", "sha256": "38edfc2c3926672882e17e751efdd526ce5facb484b0612f82ee1729c316eb75" }, "downloads": -1, "filename": "midr-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "581aef3cdd6b30e11f27d3992e6e5cce", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10610, "upload_time": "2019-09-05T14:40:30", "url": "https://files.pythonhosted.org/packages/d8/95/5ced8866b54f6a34227513ad5124ebcb81cb4f569aa4c0cb1cf98b07cc57/midr-1.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b9300ca5c2c26b79a911066bf9f29e6a", "sha256": "f19562a24275780d2ac53e64e38e9986555efd91d87a1abbade1905b598c1a3c" }, "downloads": -1, "filename": "midr-1.0.3.tar.gz", "has_sig": false, "md5_digest": "b9300ca5c2c26b79a911066bf9f29e6a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11630, "upload_time": "2019-09-05T14:40:34", "url": "https://files.pythonhosted.org/packages/c1/f6/4d8715d7c8ebf1ac18ae3cb8d916dfdd6796252fa8da7baab8230f197756/midr-1.0.3.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "5b190b2909ad32a3fbe0da5b9d5b4dca", "sha256": "48d6385672ec1cfd6954515b337a60bb2eac2dbc921868b4eb41d0aabeb89135" }, "downloads": -1, "filename": "midr-1.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "5b190b2909ad32a3fbe0da5b9d5b4dca", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10738, "upload_time": "2019-09-05T15:13:39", "url": "https://files.pythonhosted.org/packages/95/9e/487581b0ba836633c8ce539990e66477565311db76130b0126a52c68067d/midr-1.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c06e9d06919c03a9fea0837949c39e8f", "sha256": "a126cefc80186883cc1fcb9a667b702264da61f13e5b010334f71d011d1598d3" }, "downloads": -1, "filename": "midr-1.0.4.tar.gz", "has_sig": false, "md5_digest": "c06e9d06919c03a9fea0837949c39e8f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11894, "upload_time": "2019-09-05T15:13:44", "url": "https://files.pythonhosted.org/packages/c1/ff/98a787e46ab4a64960b326cbfb840fa771c5b41d346491939114526f76a4/midr-1.0.4.tar.gz" } ], "1.0.5": [ { "comment_text": "", "digests": { "md5": "c710fbfb372555b6faecbebca3142626", "sha256": "e20b4ed1d34658f64f482d81e538d1ea952e58d0bdd2751283a82726683583c9" }, "downloads": -1, "filename": "midr-1.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "c710fbfb372555b6faecbebca3142626", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10788, "upload_time": "2019-09-05T15:59:10", "url": "https://files.pythonhosted.org/packages/91/97/6dd3be09416d130cc6593feb0d9a11847a1f2c256552214a007e17891e5d/midr-1.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4d68f275c5bb5ea08bbbafad3f7c65bc", "sha256": "91a97aeed3d1a6a40915afeea2f78c16f824bbe1afd338368db30e37e13cde09" }, "downloads": -1, "filename": "midr-1.0.5.tar.gz", "has_sig": false, "md5_digest": "4d68f275c5bb5ea08bbbafad3f7c65bc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11945, "upload_time": "2019-09-05T15:59:16", "url": "https://files.pythonhosted.org/packages/27/67/305f083726a7d7d4c70ff3bffb39747c777f4071b1325235baf2529d5eb9/midr-1.0.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c710fbfb372555b6faecbebca3142626", "sha256": "e20b4ed1d34658f64f482d81e538d1ea952e58d0bdd2751283a82726683583c9" }, "downloads": -1, "filename": "midr-1.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "c710fbfb372555b6faecbebca3142626", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10788, "upload_time": "2019-09-05T15:59:10", "url": "https://files.pythonhosted.org/packages/91/97/6dd3be09416d130cc6593feb0d9a11847a1f2c256552214a007e17891e5d/midr-1.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4d68f275c5bb5ea08bbbafad3f7c65bc", "sha256": "91a97aeed3d1a6a40915afeea2f78c16f824bbe1afd338368db30e37e13cde09" }, "downloads": -1, "filename": "midr-1.0.5.tar.gz", "has_sig": false, "md5_digest": "4d68f275c5bb5ea08bbbafad3f7c65bc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11945, "upload_time": "2019-09-05T15:59:16", "url": "https://files.pythonhosted.org/packages/27/67/305f083726a7d7d4c70ff3bffb39747c777f4071b1325235baf2529d5eb9/midr-1.0.5.tar.gz" } ] }