R/display_attrs.R

Defines functions display_attribute_values display_attributes

Documented in display_attributes display_attribute_values

#' Display Attribute Informations
#'
#' Given a GHO object and an attribute name, return the
#' distinct values taken by the attribute.
#'
#' @param x A GHO object.
#' @param attribute Name of an attribute.
#'
#' @return A character vector of the distinct values taken
#'   by the attribute.
#' @export
display_attribute_values <- function(x, attribute) {
  gho_attr <- attr(x, "attr")
  stopifnot(
    ! is.null(gho_attr),
    length(attribute) == 1,
    attribute %in% names(gho_attr)
  )

  res <- gho_attr[[attribute]]
  sort(unique(res[! is.na(res)]))
}

#' @export
#' @rdname display_attribute_values
display_attributes <- function(x) {
  names(attr(x, "attr"))
}
pierucci/rgho documentation built on May 25, 2019, 7:11 a.m.