Skip to main content

A Python library for connecting genetic records with specimen data.

Project description

Genetic Collections

Latest PyPI version Continuous integration status Documentation status

A Python library for connecting genetic records with specimen data.

Installation

This software requires a working installation of Python 3.5 or higher. Your Python installation should come with a command-line tool called “pip”, which is used to download packages from PyPI, the Python Package Index. Run the command below, and you should be good to go!

pip install genetic_collections

Command Line Usage

The installation from pip should also install several command line programs that act as wrappers for the code contained here.

Here are the available command line tools:

  • ncbi_inst_search

$ ncbi_inst_search "Smithsonian"

6 matching results found.
 Fetching biocollection entries.
 [
   {
     "Collection Type": "museum",
     "gb_count": 20697,
     "Country": "USA",
     "Institution Code": "USNM",
     "NCBI Link": "https://www.ncbi.nlm.nih.gov/biocollections/53",
     "Institution Name": "National Museum of Natural History, Smithsonian Institution"
   },
   {
     "Collection Type": "herbarium",
     "gb_count": 5269,
     "Country": "USA",
     "Institution Code": "US",
     "NCBI Link": "https://www.ncbi.nlm.nih.gov/biocollections/7399",
     "Institution Name": "Smithsonian Institution, Department of Botany"
   },
   ...
  • gb_search

$ gb_search -inst_code USNM

Your search found 20697 hits in GenBank
You can see you search results online at
https://www.ncbi.nlm.nih.gov/nuccore/?term=%22collection+USNM%22%5Bprop%5D
  • gb_fetch

  • bold_inst_search

  • bold_search

  • bold_fetch

Python Library Usage

The best way to illustrate how the Python library can be used is to view the example workflow in the Jupyter notebook in the “examples” directory.

How to contribute

Imposter syndrome disclaimer: I want your help. No really, I do.

There might be a little voice inside that tells you you’re not ready; that you need to do one more tutorial, or learn another framework, or write a few more blog posts before you can help me with this project.

I assure you, that’s not the case.

This project has some clear Contribution Guidelines and expectations that you can read here (link).

The contribution guidelines outline the process that you’ll need to follow to get a patch merged. By making expectations and process explicit, I hope it will make it easier for you to contribute.

And you don’t just have to write code. You can help out by writing documentation, tests, or even by giving feedback about this work. (And yes, that includes giving feedback about the contribution guidelines.)

Thank you for contributing!

Next Steps

  • Incorporate MIXS standards

  • Add the ability to translate GenBank and BOLD results to DwC format in order to compare

  • Add iDigBio and GBIF APIs as data sources for specimen data (and GenBank accessions)

Credits

“How to contribute” was taken from https://github.com/adriennefriend/imposter-syndrome-disclaimer.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2017-10-05)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

genetic_collections-0.1.9.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

genetic_collections-0.1.9-py2.py3-none-any.whl (10.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file genetic_collections-0.1.9.tar.gz.

File metadata

File hashes

Hashes for genetic_collections-0.1.9.tar.gz
Algorithm Hash digest
SHA256 92ff0b9495813c5ab0238077780795c6fd1e81367e001aa05552eb8f9b8278c1
MD5 322013072128d49dd8c767de0b866732
BLAKE2b-256 0b0b9fc1fdc0250e020e93eefe5c117fdcb740d5fe0b5228449036a0ea7527f4

See more details on using hashes here.

File details

Details for the file genetic_collections-0.1.9-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for genetic_collections-0.1.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b0ef568f638ee66b99160e4bbe63e814d06c2a3dde070baf8994d705a5ef90c1
MD5 6d8062cde94d58c849c32dabb47ee436
BLAKE2b-256 66813f51325c515bc78eb06338cc10d257f42b8a4591d158b8df036cf2f13c82

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page