{ "info": { "author": "kpj", "author_email": "kpjkpjkpjkpjkpjkpj@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3.6", "Topic :: Scientific/Engineering :: Bio-Informatics" ], "description": "RNAseq Analysis Pipeline\n========================\n\n|PyPI| |Build Status|\n\nInstallation\n------------\n\nInstall ``seqpipe`` using ``pip``:\n\n.. code:: bash\n\n $ pip install seqpipe\n\n``seqpipe`` offers various commandline-arguments:\n\n::\n\n $ seqpipe --help\n Usage: seqpipe [OPTIONS] COMMAND [ARGS]...\n\n Options:\n --help Show this message and exit.\n\n Commands:\n map\n stats\n\nIn particular, the mapping pipeline is interesting:\n\n.. code:: bash\n\n $ seqpipe map --help\n Usage: seqpipe map [OPTIONS]\n\n Options:\n -r, --read PATH Path to read file/directory. [required]\n -g, --genome PATH Path to genome file/directory. [required]\n -o, --output DIRECTORY Directory to save results to.\n --scripts / --no-scripts Whether to execute scripts or not.\n -m, --min-read-len INTEGER Minimal read length.\n -M, --max-read-len INTEGER Maximal read length.\n -b, --bowtie-args TEXT Extra arguments for bowtie.\n -t, --threads INTEGER How many threads to run in.\n --help Show this message and exit.\n\nUsage\n-----\n\nTo map a directory of reads to two references, execute it as follows:\n\n.. code:: bash\n\n $ seqpipe map \\\n -r seqpipe/tests/data/reads/ \\\n -g seqpipe/tests/data/references/10-ref.fa \\\n -g seqpipe/tests/data/references/20-ref.fa \\\n -o my_mapping\n\nThis will create a ``my_mapping`` directory which contains two\ndirectories: \\* ``runs`` stores all data related to each individual read\nfile \\* ``results`` contains data generated by scripts from the\n``scripts`` folder\n\nAn overview of the read distributions can then be generated via:\n\n.. code:: bash\n\n $ seqpipe stats plot_rdist -o my_images/ my_mapping/\n\nExtras\n------\n\nAdditional useful scripts are contained in ``extra``. The entry point is\n``main.py`` (check ``python ./extra/main.py --help`` for help).\n\nThe respective individual files are: \\* ``sequential_pipeline.sh`` \\*\nmap length-filtered reads against multiple genomes in succession \\*\n``plot_sequential_data.py`` \\* visualize data obtained from sequential\npipeline \\* ``plot_expression_differences.py`` \\* visualize differences\nin RNAseq expression levels over pairs of samples\n\nLinks\n-----\n\n- `Github `__\n- `PyPi `__\n\nDependencies\n------------\n\nTools: \\* cutadapt \\* fastqc \\* `more\ninfo `__\n\\* bowtie \\* samtools \\*\n`specifications `__ \\*\nbedtools\n\nLanguages: \\* bash \\* python \\* numpy \\* pandas \\* seaborn \\* matplotlib\n\\* tqdm \\* biopython \\* pysam \\* joblib \\* click \\* sh \\* colorama\n\nDevelopment notes\n-----------------\n\nTests\n~~~~~\n\nRun tests using:\n\n.. code:: bash\n\n $ tox\n\nRelease package\n~~~~~~~~~~~~~~~\n\nThis guide assumes a properly setup ``~/.pypirc``.\n\nBuild package:\n\n.. code:: bash\n\n $ python setup.py sdist\n\nRegister it (only once):\n\n.. code:: bash\n\n $ twine register dist/seqpipe-X.Y.Z.tar.gz\n\nTry installation locally:\n\n.. code:: bash\n\n $ rm -rf /tmp/seqpipe_tmp\n $ virtualenv /tmp/seqpipe_tmp\n $ /tmp/seqpipe_tmp/bin/pip install dist/seqpipe-X.Y.Z.tar.gz\n $ /tmp/seqpipe_tmp/bin/seqpipe --help\n\nTry installation using test-servers:\n\n.. code:: bash\n\n $ twine upload -r test dist/seqpipe-X.Y.Z.tar.gz\n $ pip install -i https://testpypi.python.org/pypi seqpipe\n $ seqpipe --help\n\nCheck `testpypi-page `__.\n\nFinally, install it on actual server:\n\n.. code:: bash\n\n $ twine upload dist/seqpipe-X.Y.Z.tar.gz\n $ pip install -U seqpipe\n $ seqpipe --help\n\nCheck actual `pypi-page `__.\n\nMisc\n~~~~\n\nCreate dev-builds with:\n\n.. code:: bash\n\n $ pip install --user -e .\n\nRun uninstalled version:\n\n.. code:: bash\n\n $ python -m seqpipe.main\n\nEnable bash-autocompletion as follows:\n\n.. code:: bash\n\n $ _SEQPIPE_COMPLETE=source seqpipe >> ~/.bashrc\n $ . ~/.bashrc\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/seqpipe.svg?style=flat\n :target: \n.. |Build Status| image:: https://travis-ci.org/kpj/SeqPipe.svg?branch=master\n :target: https://travis-ci.org/kpj/SeqPipe", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kpj/SeqPipe", "keywords": "bioinformatics sequencing pipeline alignment mapping", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "seqpipe", "package_url": "https://pypi.org/project/seqpipe/", "platform": "", "project_url": "https://pypi.org/project/seqpipe/", "project_urls": { "Homepage": "https://github.com/kpj/SeqPipe" }, "release_url": "https://pypi.org/project/seqpipe/0.0.7/", "requires_dist": null, "requires_python": "", "summary": "Sequencing pipeline", "version": "0.0.7" }, "last_serial": 3117065, "releases": { "0.0.3": [], "0.0.4": [ { "comment_text": "", "digests": { "md5": "3021450accf95923b0a99cfc443c60f8", "sha256": "3774fd0637e80e3256bc2125dbbcb6b1f5ce1a4dd98b43fd05949be6f36b29d0" }, "downloads": -1, "filename": "seqpipe-0.0.4.tar.gz", "has_sig": false, "md5_digest": "3021450accf95923b0a99cfc443c60f8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7367, "upload_time": "2017-05-30T20:55:50", "url": "https://files.pythonhosted.org/packages/d1/3f/74d8e31739eaa5c51bf9c1f9fd624483fa8ee8feab3f04335ba24f1e3b2c/seqpipe-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "ffb528b999f3b58bbacdd90533206ae4", "sha256": "f6a24bc9c93bfbef85f797e8d344e08861d441c9199ff3020fdba6f1f1fff1f8" }, "downloads": -1, "filename": "seqpipe-0.0.5.tar.gz", "has_sig": false, "md5_digest": "ffb528b999f3b58bbacdd90533206ae4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9720, "upload_time": "2017-05-31T21:06:06", "url": "https://files.pythonhosted.org/packages/85/08/ae57e69d3806434a97ea447c6a74254e5f3bcd6c605e416d882029711c14/seqpipe-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "1c361563983df65619335167fa830b0e", "sha256": "639e8b11bf73b329fc98a926efa5a4e448fe998f3d20b5628d67c5c96e5b52d9" }, "downloads": -1, "filename": "seqpipe-0.0.6.tar.gz", "has_sig": false, "md5_digest": "1c361563983df65619335167fa830b0e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10308, "upload_time": "2017-06-01T09:03:07", "url": "https://files.pythonhosted.org/packages/87/e2/2ccb57606eaef514924429c79cfce18639feaec38276204e4f6ced4020da/seqpipe-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "30fbf82ac974e71576fff616b5770a01", "sha256": "8056a890d6ff692b409dc26b8b14f318a0ee86098b23af57d73f027c0d12ba08" }, "downloads": -1, "filename": "seqpipe-0.0.7.tar.gz", "has_sig": false, "md5_digest": "30fbf82ac974e71576fff616b5770a01", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11987, "upload_time": "2017-08-23T10:03:21", "url": "https://files.pythonhosted.org/packages/b6/2c/154fcdd3c9ec7e31b51df5c9100db2344cfd59d5ad434008574b8b0dec2e/seqpipe-0.0.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "30fbf82ac974e71576fff616b5770a01", "sha256": "8056a890d6ff692b409dc26b8b14f318a0ee86098b23af57d73f027c0d12ba08" }, "downloads": -1, "filename": "seqpipe-0.0.7.tar.gz", "has_sig": false, "md5_digest": "30fbf82ac974e71576fff616b5770a01", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11987, "upload_time": "2017-08-23T10:03:21", "url": "https://files.pythonhosted.org/packages/b6/2c/154fcdd3c9ec7e31b51df5c9100db2344cfd59d5ad434008574b8b0dec2e/seqpipe-0.0.7.tar.gz" } ] }