Translate data sqids

NAMESPACE

@@ -11,6 +11,7 @@ export(get_meta_response)
 export(get_publications)
 export(http_request_error)
 export(parse_api_dataset)
+export(parse_data_squids)
 export(parse_filter_in)
 export(parse_meta_filter_columns)
 export(parse_meta_filter_item_ids)

R/parse_data_squids.R

@@ -0,0 +1,26 @@
+#' Parse IDs in returned API data
+#'
+#' @description
+#' The API uses unique IDs (squids) to identify each filter column, filter_item and indicator column.
+#' This facilitates continuity, i.e. data creators may need to change the col_name and labeling in
+#' their data files, whilst maintaining the same fundamental content. Results from the API are given
+#' using these IDs, but it's expected that analysts will want to translate these back into the
+#' col_names assigned by analysts. `parse_data_squids()` takes a data frame extracted from the API
+#' and translates all the squids in that data frame to their assigned col_names based on the meta
+#' data available from the API.
+#'
+#' @param data Data frame containing data as returned from the API by `get_dataset()` or
+#' `post_dataset()`
+#' @param datatset_id String containing the data set ID
+#'
+#' @return Data frame
+#' @export
+#'
+#' @examples
+#' get_dataset(example_id(), indicators = example_id("indicator"), page = 1) |>
+#'   parse_data_squids(example_id())
+parse_data_squids <- function(
+    data,
+    datatset_id) {
+  meta <- get_meta(dataset_id)
+}