completed matching functions to webservice

DESCRIPTION

@@ -8,9 +8,9 @@ Suggests: knitr,
 Imports: RCurl,
          XML,
          utils
-Description: R interface to access the web services of the ICES (International
+Description: R interface to access the RECO POX web services of the ICES (International
              Council for the Exploration of the Sea) Vocabularies
-             database <http://vocab.ices.dk/services/RDF.aspx>.
+             database <http://vocab.ices.dk/services/POX.aspx>.
 License: GPL (>= 2)
-URL: http://vocab.ices.dk/services/RDF.aspx
+URL: http://vocab.ices.dk/services/POX.aspx
 RoxygenNote: 5.0.1

NAMESPACE

@@ -1,6 +1,8 @@
 # Generated by roxygen2: do not edit by hand
 
+export(getCodeDetail)
 export(getCodeList)
+export(getCodeTypeList)
 importFrom(RCurl,basicTextGatherer)
 importFrom(RCurl,curlPerform)
 importFrom(XML,getChildrenStrings)

R/getCodeDetail.R

@@ -0,0 +1,31 @@
+#' Get List of Details
+#'
+#' Retrieves all the details for the given code.
+#'
+#' @param code_type the code type, e.g. SpecWoRMS
+#' @param code the code, e.g. 101170
+#'
+#' @return A data frame.
+#'
+#' @examples
+#' # get the details for species code 101170
+#' getCodeDetail("SpecWoRMS", "101170")
+#'
+#' @export
+getCodeDetail <- function(code_type, code) {
+
+  # base url
+  url <- sprintf("http://vocab.ices.dk/services/pox/GetCodeDetail/%s/%s", code_type, code)
+
+  # read and parse XML from API
+  out <- curlVocab(url = url)
+  # parse the xml text string suppplied by the Datras webservice
+  # returning a dataframe
+  out <- parseVocab(out)
+
+  # for now, drop parent relation...
+  out <- out[names(out) != "ParentRelation"]
+
+  # return
+  out
+}

R/getAphiaID.R → R/getCodeList.R

@@ -2,17 +2,29 @@
 #'
 #' Retrieves all the codes for the given code type.
 #'
+#' @param code_type the code type, e.g. SpecWoRMS
+#' @param date restrict output to codes
+#'             modified after the given date.
+#'             date should be text and in the fomat "yyyy-mm-dd", e.g. "2010-12-01"
+#'
 #' @return A data frame.
 #'
 #' @examples
 #' # get the WoRMS AphiaIDs for ICES assessment species
 #' getCodeList("SpecWoRMS")
 #'
 #' @export
-getCodeList <- function(code_type) {
+getCodeList <- function(code_type, date=NULL) {
 
-  # read and parse XML from API
+  # base url
   url <- sprintf("http://vocab.ices.dk/services/pox/GetCodeList/%s", code_type)
+
+  # if date supplied return list of codes modified after the given date
+  if (!is.null(date)) {
+    url <- sprintf(paste0(url, "/%s"), date)
+  }
+
+  # read and parse XML from API
   out <- curlVocab(url = url)
   # parse the xml text string suppplied by the Datras webservice
   # returning a dataframe

R/getCodeTypeList.R

@@ -0,0 +1,34 @@
+#' Get List of Code Types
+#'
+#' Retrieves all the codes types.
+#'
+#' @param date restrict output to code types
+#'             modified after the given date.
+#'             date should be text and in the fomat "yyyy-mm-dd", e.g. "2010-12-01"
+#'
+#' @return A data frame.
+#'
+#' @examples
+#' codes <- getCodeTypeList()
+#' codes[grep("worms", tolower(codes$Description)),]
+#'
+#' @export
+getCodeTypeList <- function(date=NULL) {
+
+  # base url
+  url <- "http://vocab.ices.dk/services/pox/GetCodeTypeList"
+
+  # if date supplied return list of code types modified after the given date
+  if (!is.null(date)) {
+    url <- sprintf(paste0(url, "/%s"), date)
+  }
+
+  # read and parse XML from API
+  out <- curlVocab(url = url)
+  # parse the xml text string suppplied by the Datras webservice
+  # returning a dataframe
+  out <- parseVocab(out)
+
+  # return
+  out
+}

README.md

@@ -10,7 +10,7 @@
 icesVocab
 ======
 
-icesVocab implements R functions that access the [web services](http://vocab.ices.dk/services/RDF.aspx) of the [ICES (International Council for the Exploration of the Sea)](http://www.ices.dk/Pages/default.aspx) [Vocabularies](http://vocab.ices.dk/).
+icesVocab implements R functions that access the [RECO POX web services](http://vocab.ices.dk/services/POX.aspx) of the [ICES (International Council for the Exploration of the Sea)](http://www.ices.dk/Pages/default.aspx) [Vocabularies](http://vocab.ices.dk/).
 
 icesVocab is implemented as an [R](https://www.r-project.org) package and available on [GitHub](https://cran.r-project.org/package=icesVocab).
 
@@ -36,9 +36,9 @@ library(icesVocab)
 References
 ----------
 
-ICES Vocab web services:
+ICES Vocabularies RECO POX web services:
 
-[http://vocab.ices.dk/services/RDF.aspx](http://vocab.ices.dk/services/RDF.aspx).
+[http://vocab.ices.dk/services/POX.aspx](http://vocab.ices.dk/services/POX.aspx).
 
 ICES Vocab: