create function to structure icd_get_foundation output

NAMESPACE

@@ -5,6 +5,7 @@ export(icd_get_entity)
 export(icd_get_foundation)
 export(icd_oauth_client)
 export(icd_search_foundation)
+export(icd_structure_foundation)
 importFrom(httr,oauth2.0_token)
 importFrom(httr,oauth_app)
 importFrom(httr,oauth_endpoint)

R/icd_structure.R

@@ -0,0 +1,38 @@
+#'
+#' Structure ICD list outputs
+#'
+#' @param icd_list An `icd_list` object produced by a call to any of the `icd_get`
+#'   functions
+#'
+#' @return An object of class `icd_tbl` which is basically a `data.frame` format
+#'   of ICD outputs
+#'
+#' @examples
+#' icd_list <- icd_get_foundation()
+#' icd_tbl_foundation <- icd_structure_foundation(icd_list)
+#'
+#' @rdname icd_structure
+#' @export
+#'
+icd_structure_foundation <- function(icd_list) {
+  ## Structure title ----
+  icd_list$title <- do.call(cbind, icd_list$title) |> data.frame()
+
+  ## Structure availableLanguages ----
+  icd_list$availableLanguages <- unlist(icd_list$availableLanguages) |>
+    paste(collapse = ", ")
+
+  ## Structure child ----
+  icd_list$child <- unlist(icd_list$child) |> list()
+
+  ## Bind columns and rename columns ----
+  icd_tbl <- do.call(cbind, icd_list)
+  names(icd_tbl)[3] <- "title@language"
+  names(icd_tbl)[4] <- "title@value"
+  names(icd_tbl)[8] <- "child"
+
+  ## Create `icd_tbl` class object ----
+  class(icd_tbl) <- "icd_tbl"
+
+  icd_tbl
+}

docs/pkgdown.yml

@@ -2,7 +2,7 @@ pandoc: 3.1.1
 pkgdown: 2.0.7
 pkgdown_sha: ~
 articles: {}
-last_built: 2024-02-13T16:55Z
+last_built: 2024-02-14T13:53Z
 urls:
   reference: https://oxford-ihtm.io/codigo/reference
   article: https://oxford-ihtm.io/codigo/articles

docs/sitemap.xml

@@ -42,6 +42,9 @@
   <url>
     <loc>https://oxford-ihtm.io/codigo/reference/icd_search_foundation.html</loc>
   </url>
+  <url>
+    <loc>https://oxford-ihtm.io/codigo/reference/icd_structure.html</loc>
+  </url>
   <url>
     <loc>https://oxford-ihtm.io/codigo/reference/icd_versions.html</loc>
   </url>

pkgdown/_pkgdown.yml

@@ -56,6 +56,10 @@ reference:
     - icd_get_foundation
     - icd_get_entity
 
+  - title: Structure
+    contents:
+    - icd_structure_foundation
+
   - title: Supporting datasets
     contents:
     - icd_versions