<p align="center" > <img src="https://raw.githubusercontent.com/gservera/TaxonomyKit/master/banner.png" width="750" alt="TaxonomyKit" title="TaxonomyKit"> </p>

TaxonomyKit

TaxonomyKit is a powerful, handy and cross-platform library that makes working with taxonomy data from the NCBI databases easier. It works as a client of the NCBI's Entrez Programming Utilities and it is the core of the Taxonomist app.

How To Get Started

• Download TaxonomyKit or fecth it using Swift Package Manager.
• Check out the Documentation for the Taxonomy struct or just read the following section to begin quickly.

First steps

🔭 Get the NCBI's Taxonomy ID for the taxon you're looking for

let myCoolQuery = "quercus ilex"
Taxonomy.findIdentifiers(for: myCoolQuery) { result in
    switch result {
    case .success(let foundIDs):
        print("Found identifiers: \(foundIDs).")
    case .failure(let error):
        print("Oops! Something went wrong. Error was: \(error)")
    }
}

⬇️ Download your taxa

let foundIDs: [TaxonID] = [58334] // Use the one you got from previous step.
Taxonomy.downloadTaxa(identifiers: [foundIDs]) { result in
    switch result {
    case .success(let taxa):
        print("Got \(taxa.count) taxa.")
    case .failure(let error):
        print("Oops! Something went wrong. Error was: \(error)")
    }
}

📖 Get an extract from Wikipedia

Wikipedia.retrieveAbstract(for: downloadedTaxon) { result in
    switch result {
    case .success(let wikipediaResult):
        print("Got info: \(wikipediaResult.extract).")
    case .failure(let error):
        print("Oops! Something went wrong. Error was: \(error)")
    }
}

Requirements

• macOS 10.14 Mojave or greater.
• Xcode 11 or greater.

Unit Tests

TaxonomyKit includes a suite of unit tests within the Tests subdirectory. These tests can be run simply be executed the test action on the platform framework you would like to test.

☕️ Author

Proudly developed by Guillem Servera Negre in Palma, Illes Balears.

License

TaxonomyKit is released under the MIT license. See LICENSE for details.