<p>
<img src="docs/img/uceasy_logo.png" height="200px">
</p>
[](https://github.com/uceasy/uceasy/actions?workflow=Tests)
[](https://sonarcloud.io/dashboard?id=uceasy_uceasy)
[](https://zenodo.org/badge/latestdoi/203415455)
# UCEasy: A software package for automating and simplifying the analysis of ultraconserved elements (UCEs)
__UCEasy__ is a Python wrapper that standardizes, automates, and simplifies the following [PHYLUCE](https://phyluce.readthedocs.io/en/latest) tasks: quality control of raw reads, assembly, alignment and UCE loci extraction.
Although the PHYLUCE pipeline is robust and well-established, it requires the execution of many command line scripts from heterogeneous tools, which can be quite challenging for scientists without some training in bioinformatics.
For more information check out our [Wiki](https://github.com/uceasy/uceasy/wiki).
## Installation Guide
### Dependencies
* Python ^3.7
* PHYLUCE 1.6.* (1.7 not supported yet)
Install the package from [PyPI](https://pypi.org/project/uceasy/):
```
$ pip install uceasy
```
Then, make sure you have a working installation of PHYLUCE, check out the installation guide at [PHYLUCE's documentation](https://phyluce.readthedocs.io/en/latest/installation.html).
## Workflow
The operations [Trim](https://github.com/uceasy/uceasy/wiki/Trim), [Assemble](https://github.com/uceasy/uceasy/wiki/Assemble) and [Align](https://github.com/uceasy/uceasy/wiki/Align) represent the following workflow. The following image demonstrates how the PHYLUCE workflow is abstracted by UCEasy.
<p>
<img src="docs/img/phyluce-uceasy-comparison.png" height="500px">
</p>
The colored boxes are UCEasy CLI commands.
```
$ uceasy trim
$ uceasy assemble
$ uceasy align
```
Explore the options for these commands with the `--help` flag.<br>
For a guide of how to use UCEasy see: [Tutorial](https://github.com/uceasy/uceasy/wiki/Tutorial).
## Acknowledgements
We thank the following institutions, which contributed to ensuring the success of our work:
Ministério da Ciência, Tecnologia, Inovação e Comunicação (MCTIC)
Museu Paraense Emílio Goeldi (MPEG)
Instituto Nacional de Pesquisas da Amazônia (INPA)
Centro Universitário do Estado do Pará (CESUPA)
## Funding
This research was supported by Conselho Nacional de Desenvolvimento Científico e Tecnológico - CNPq (fellowships 149985/2018-5; 129954/2018-7). Romina Batista was supported by a postdoctoral fellowship granted from Coordenação de Aperfeiçoamento de Pessoal de Nível Superior – Brasil (CAPES-INPA proc. 88887477562/2020-00).
## Authors
Caio Vinícius Raposo Ribeiro<br>
Lucas Peres Oliveira<br>
Romina Batista<br>
Marcos Paulo Alves de Sousa
## Contact
Dr. Marcos Paulo Alves de Sousa (Project leader)
_Email: **msousa@museu-goeldi.br**_<br>
_Laboratório de Biologia Molecular-LBM_<br>
_Grupo de pesquisa em Bioinformática e Informática para Biodiversidade (BioInfo)_<br>
_Museu Paraense Emílio Goeldi_<br>
_Av. Perimetral 1901. CEP 66077- 530. Belém, Pará, Brazil._
Raw data
{
"_id": null,
"home_page": "https://uceasy.github.io",
"name": "uceasy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "uce,phyluce,ultraconserved elements",
"author": "Caio Raposo",
"author_email": "caioraposo@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/1e/e6/551d422a6f6e2efea82d1221398dcf08041bd03d4e83fae4e44c1fd2dacd/uceasy-0.3.1.tar.gz",
"platform": null,
"description": "<p>\n <img src=\"docs/img/uceasy_logo.png\" height=\"200px\">\n\n</p>\n\n[](https://github.com/uceasy/uceasy/actions?workflow=Tests)\n[](https://sonarcloud.io/dashboard?id=uceasy_uceasy)\n[](https://zenodo.org/badge/latestdoi/203415455)\n\n# UCEasy: A software package for automating and simplifying the analysis of ultraconserved elements (UCEs)\n\n\n__UCEasy__ is a Python wrapper that standardizes, automates, and simplifies the following [PHYLUCE](https://phyluce.readthedocs.io/en/latest) tasks: quality control of raw reads, assembly, alignment and UCE loci extraction.\n\n\nAlthough the PHYLUCE pipeline is robust and well-established, it requires the execution of many command line scripts from heterogeneous tools, which can be quite challenging for scientists without some training in bioinformatics. \n\nFor more information check out our [Wiki](https://github.com/uceasy/uceasy/wiki).\n## Installation Guide\n### Dependencies\n* Python ^3.7\n* PHYLUCE 1.6.* (1.7 not supported yet)\n\nInstall the package from [PyPI](https://pypi.org/project/uceasy/):\n```\n$ pip install uceasy\n```\nThen, make sure you have a working installation of PHYLUCE, check out the installation guide at [PHYLUCE's documentation](https://phyluce.readthedocs.io/en/latest/installation.html).\n\n\n## Workflow\nThe operations [Trim](https://github.com/uceasy/uceasy/wiki/Trim), [Assemble](https://github.com/uceasy/uceasy/wiki/Assemble) and [Align](https://github.com/uceasy/uceasy/wiki/Align) represent the following workflow. The following image demonstrates how the PHYLUCE workflow is abstracted by UCEasy.\n\n<p>\n <img src=\"docs/img/phyluce-uceasy-comparison.png\" height=\"500px\">\n\n</p>\n\nThe colored boxes are UCEasy CLI commands.\n```\n$ uceasy trim\n$ uceasy assemble\n$ uceasy align\n```\nExplore the options for these commands with the `--help` flag.<br>\n\nFor a guide of how to use UCEasy see: [Tutorial](https://github.com/uceasy/uceasy/wiki/Tutorial).\n\n\n## Acknowledgements\n\nWe thank the following institutions, which contributed to ensuring the success of our work:\n\nMinist\u00e9rio da Ci\u00eancia, Tecnologia, Inova\u00e7\u00e3o e Comunica\u00e7\u00e3o (MCTIC)\n\nMuseu Paraense Em\u00edlio Goeldi (MPEG)\n\nInstituto Nacional de Pesquisas da Amaz\u00f4nia (INPA)\n\nCentro Universit\u00e1rio do Estado do Par\u00e1 (CESUPA)\n\n## Funding\n\n This research was supported by Conselho Nacional de Desenvolvimento Cient\u00edfico e Tecnol\u00f3gico - CNPq (fellowships 149985/2018-5; 129954/2018-7). Romina Batista was supported by a postdoctoral fellowship granted from Coordena\u00e7\u00e3o de Aperfei\u00e7oamento de Pessoal de N\u00edvel Superior \u2013 Brasil (CAPES-INPA proc. 88887477562/2020-00).\n\n\n## Authors\n\n Caio Vin\u00edcius Raposo Ribeiro<br>\n Lucas Peres Oliveira<br>\n Romina Batista<br>\n Marcos Paulo Alves de Sousa\n\n\n ## Contact\n\nDr. Marcos Paulo Alves de Sousa (Project leader)\n\n_Email: **msousa@museu-goeldi.br**_<br>\n_Laborat\u00f3rio de Biologia Molecular-LBM_<br>\n_Grupo de pesquisa em Bioinform\u00e1tica e Inform\u00e1tica para Biodiversidade (BioInfo)_<br>\n_Museu Paraense Em\u00edlio Goeldi_<br>\n_Av. Perimetral 1901. CEP 66077- 530. Bel\u00e9m, Par\u00e1, Brazil._\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Wrapper for the Phyluce phylogenomics software package",
"version": "0.3.1",
"split_keywords": [
"uce",
"phyluce",
"ultraconserved elements"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dbc2332b7bf1939936f164d535ac6fcba4ef35d91301d5f646267e04c58deea6",
"md5": "90eafe21f8b7ce070550836ff4de598b",
"sha256": "6e6315ff7d3530aa0f4b71e232beb6fd9f2cde990d16f3510d49ffadda406818"
},
"downloads": -1,
"filename": "uceasy-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90eafe21f8b7ce070550836ff4de598b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 12232,
"upload_time": "2023-03-31T02:13:03",
"upload_time_iso_8601": "2023-03-31T02:13:03.549045Z",
"url": "https://files.pythonhosted.org/packages/db/c2/332b7bf1939936f164d535ac6fcba4ef35d91301d5f646267e04c58deea6/uceasy-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ee6551d422a6f6e2efea82d1221398dcf08041bd03d4e83fae4e44c1fd2dacd",
"md5": "ad9eedb54c92279e71b398151f871a92",
"sha256": "e954bfbfacb8bf178f34b0ee765c5fe02d980a2dd7856816425e3b832d524aae"
},
"downloads": -1,
"filename": "uceasy-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "ad9eedb54c92279e71b398151f871a92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 11568,
"upload_time": "2023-03-31T02:13:05",
"upload_time_iso_8601": "2023-03-31T02:13:05.382218Z",
"url": "https://files.pythonhosted.org/packages/1e/e6/551d422a6f6e2efea82d1221398dcf08041bd03d4e83fae4e44c1fd2dacd/uceasy-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-31 02:13:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "uceasy"
}
JSON