R/select.R

In FvD/conceptr: Tools to work with concept hierarchies

#' Select at level
#'
#' Get all the variables at the given level (level 1 for the highest level). If
#' the requested level does not exist give a warning.
#'
#' Note that you are only selecting, not aggregating. If you want to roll-up
#' to any given level, use the aggregate_atlevel function instead.
#'
#' @param data Data object to be included
#' @param hierarchy The hierachy definition
#' @param level The level of interest
#' @export select_level
select_level <- function(data, hierarchy, level) {
  selected_level <- level
  new_hierarchy <- add_hierarchy_level(hierarchy)

  selected_columns <- new_hierarchy %>%
    filter(level == selected_level)

  column_names <- as.vector(make.names(selected_columns$name))

  # Roll up the data to the names at the requested level
  result <- data
  if (length(column_names) > 0) {
      result <- result %>%
        select(one_of(column_names))
  } else {
    print("That level does not exist")
    result <- 0
  }

  return(result)
}