#126 taxonomy fxn added

NAMESPACE

@@ -50,6 +50,7 @@ export(speed)
 export(stocks)
 export(swimming)
 export(synonyms)
+export(taxonomy)
 export(validate_names)
 importFrom(dplyr,"%>%")
 importFrom(dplyr,as_data_frame)

R/taxonomy.R

@@ -0,0 +1,34 @@
+taxendpt <- endpoint("taxa") 
+
+#' Taxonomy
+#' 
+#' @export
+#' @param genus (character) genus name. optional
+#' @param species (character) species name. optional
+#' @param limit The maximum number of matches from a single API call (e.g. 
+#' per species). Function will warn if this needs to be increased, otherwise 
+#' can be left as is. 
+#' @param server base URL to the FishBase API (by default). For SeaLifeBase, 
+#' use https://fishbase.ropensci.org/sealifebase
+#' @param ... additional arguments to httr::GET
+#' @examples 
+#' taxonomy(genus = "Oreochromis", species = "amphimelas")
+#' taxonomy(genus = "Oreochromis")
+#' taxonomy(species = "amphimelas")
+#' 
+#' taxonomy(genus = "Abrocoma", 
+#'   server = "https://fishbase.ropensci.org/sealifebase")
+taxonomy <- function(genus = NULL, species = NULL, limit = 200, 
+  server = getOption("FISHBASE_API", FISHBASE_API), ...) {
+
+  taxendpt(query = list(Genus = genus, Species = species), limit = limit, 
+           server = server, ...)
+}
+
+
+# taxonomy <- function(genus = NULL, species = NULL, limit = 200, 
+#                      server = NULL, ...) {
+#   
+#   taxendpt(query = list(Genus = genus, Species = species), limit = limit, 
+#            server = server, ...)
+# }

tests/testthat/test_taxonomy.R

@@ -0,0 +1,14 @@
+context("taxonomy")
+
+test_that('returns a data.frame with correct sciname', {
+  needs_api()
+
+  aa <- suppressWarnings(taxonomy("Oreochromis", "amphimelas"))
+  expect_is(aa, "data.frame")
+  expect_equal(aa$sciname, "Oreochromis amphimelas")
+  expect_equal(NROW(aa), 1)
+
+  bb <- suppressWarnings(taxonomy("Oreochromis"))
+  expect_is(bb, "data.frame")
+  expect_gt(NROW(bb), 10)
+})