https://github.com/dreamalligator/petrie-itis

a ITIS search wrapper to be used with Petrie
https://github.com/dreamalligator/petrie-itis

api api-wrapper classification data-structures graph itis petrie phylogeny taxonomy

Last synced: about 1 month ago
JSON representation

a ITIS search wrapper to be used with Petrie

• Host: GitHub
• URL: https://github.com/dreamalligator/petrie-itis
• Owner: dreamalligator
• Created: 2018-06-02T23:01:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-24T20:56:49.000Z (over 6 years ago)
• Last Synced: 2024-12-06T00:34:39.842Z (about 1 month ago)
• Topics: api, api-wrapper, classification, data-structures, graph, itis, petrie, phylogeny, taxonomy
• Language: JavaScript
• Homepage: https://nebulousdog.github.io/petrie-itis/
• Size: 427 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [Petrie ITIS 🦕](https://github.com/nebulousdog/petrie-itis)

![build](https://travis-ci.org/nebulousdog/petrie-itis.svg?branch=master)

![coverage](https://coveralls.io/repos/github/nebulousdog/petrie-itis/badge.svg?branch=master)

![vulnerabilities](https://snyk.io/test/github/nebulousdog/petrie-itis/badge.svg?targetFile=package.json)

A simple wrapper to query the Integrated Taxonomic Information System ([ITIS](https://www.itis.gov)) database and format the result for [Petrie](https://github.com/nebulousdog/petrie) using the [ITIS API endpoints](https://www.itis.gov/ws_description.html).

## Usage

```javascript

const ITISSearcher = require('petrie-itis');

const nepenthes = new ITISSearcher('nepenthes');

```

This queries the ITIS database, and caches the formatted data. There is a `refresh` convenience method to query the database again in case there was a network error.

## Getting started

* YARN:

  `yarn add petrie petrie-itis`

* NPM:

  `npm install petrie petrie-itis`

## Contributing

Feel free to clone the repo and make a PR!

`git clone [email protected]:nebulousdog/petrie-itis.git`

## Tests

Run tests with `yarn test`.

## License

MIT