From 0c1dac69eaa32a0ee1ddea35d50540b757e4ea4d Mon Sep 17 00:00:00 2001
From: Andrew Bruce <andrewbruce.himni@gmail.com>
Date: Sat, 23 Nov 2024 05:15:47 -0800
Subject: [PATCH] retrieve_ark function

---
 DESCRIPTION           | 10 ++++++++--
 NAMESPACE             |  4 ++++
 R/arktax.R            | 33 +++++++++++++++++++++++++++++++++
 R/generated-globals.R |  2 ++
 man/arktax-package.Rd |  2 +-
 man/retrieve_ark.Rd   | 23 +++++++++++++++++++++++
 6 files changed, 71 insertions(+), 3 deletions(-)
 create mode 100644 R/arktax.R
 create mode 100644 man/retrieve_ark.Rd

diff --git a/DESCRIPTION b/DESCRIPTION
index 91b3eee..32aed4c 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,5 +1,5 @@
 Package: arktax
-Title: What the Package Does (One Line, Title Case)
+Title: Archive: NUCC Taxonomy Codesets, 2009 - 2024
 Version: 0.0.0.9000
 Authors@R: 
     person("Andrew", "Bruce", , "andrewallenbruce@gmail.com", role = c("aut", "cre", "cph"))
@@ -10,12 +10,18 @@ URL: https://github.com/andrewallenbruce/arktax,
     https://andrewallenbruce.github.io/arktax/
 BugReports: https://github.com/andrewallenbruce/arktax/issues
 Imports: 
+    data.table,
+    dplyr,
     fs,
+    fuimus,
     glue,
     pins
 Suggests: 
     roxyglobals,
-    testthat (>= 3.0.0)
+    testthat (>= 3.0.0),
+    qs
+Remotes: 
+    andrewallenbruce/fuimus
 Config/roxyglobals/filename: generated-globals.R
 Config/roxyglobals/unique: TRUE
 Config/testthat/edition: 3
diff --git a/NAMESPACE b/NAMESPACE
index 4fefc29..b16bbd5 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -4,7 +4,11 @@ export(get_pin)
 export(gh_raw)
 export(list_pins)
 export(mount_board)
+export(retrieve_ark)
+importFrom(data.table,year)
+importFrom(dplyr,mutate)
 importFrom(fs,path_package)
+importFrom(fuimus,search_in_if)
 importFrom(glue,glue)
 importFrom(pins,board_folder)
 importFrom(pins,board_url)
diff --git a/R/arktax.R b/R/arktax.R
new file mode 100644
index 0000000..d2d35c1
--- /dev/null
+++ b/R/arktax.R
@@ -0,0 +1,33 @@
+#' Get Taxomony Source File
+#'
+#' @param year `<int>` year of rvu source file; default is `2020`
+#'
+#' @param code `<chr>` Taxonomy code
+#'
+#' @returns `<tibble>` of search results
+#'
+#' @examples
+#' retrieve_ark(2024, "101Y00000X")
+#'
+#' @importFrom dplyr mutate
+#' @importFrom data.table year
+#' @importFrom fuimus search_in_if
+#'
+#' @autoglobal
+#'
+#' @export
+retrieve_ark <- function(year = 2024, code = NULL) {
+
+  ark <- get_pin("ark_taxonomy") |>
+    mutate(year = as.character(year(release_date)))
+
+  year <- match.arg(
+    arg = as.character(year),
+    choices = as.character(ark[["year"]]),
+    several.ok = TRUE)
+
+  ark <- search_in_if(ark, ark[["year"]], year)
+  ark <- search_in_if(ark, ark[["code"]], code)
+
+  return(ark)
+}
diff --git a/R/generated-globals.R b/R/generated-globals.R
index 594cc7e..1aade94 100644
--- a/R/generated-globals.R
+++ b/R/generated-globals.R
@@ -1,5 +1,7 @@
 # Generated by roxyglobals: do not edit by hand
 
 utils::globalVariables(c(
+  # <retrieve_ark>
+  "release_date",
   NULL
 ))
diff --git a/man/arktax-package.Rd b/man/arktax-package.Rd
index 1090486..6689fb8 100644
--- a/man/arktax-package.Rd
+++ b/man/arktax-package.Rd
@@ -4,7 +4,7 @@
 \name{arktax-package}
 \alias{arktax}
 \alias{arktax-package}
-\title{arktax: What the Package Does (One Line, Title Case)}
+\title{arktax: Archive: NUCC Taxonomy Codesets, 2009 - 2024}
 \description{
 What the package does (one paragraph).
 }
diff --git a/man/retrieve_ark.Rd b/man/retrieve_ark.Rd
new file mode 100644
index 0000000..97db8ae
--- /dev/null
+++ b/man/retrieve_ark.Rd
@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/arktax.R
+\name{retrieve_ark}
+\alias{retrieve_ark}
+\title{Get Taxomony Source File}
+\usage{
+retrieve_ark(year = 2024, code = NULL)
+}
+\arguments{
+\item{year}{\verb{<int>} year of rvu source file; default is \code{2020}}
+
+\item{code}{\verb{<chr>} Taxonomy code}
+}
+\value{
+\verb{<tibble>} of search results
+}
+\description{
+Get Taxomony Source File
+}
+\examples{
+retrieve_ark(2024, "101Y00000X")
+
+}