R/getSampleDataFromYaml.R

In hbc/bcbioBase: Bcbio Base Functions

#' Get sample data from YAML
#'
#' @author Michael Steinbaugh
#' @note Updated 2022-03-07.
#' @export
#'
#' @inheritParams AcidRoxygen::params
#'
#' @return `DataFrame`.
#'
#' @examples
#' file <- file.path(bcbioBaseTestsUrl, "summary.yaml")
#' yaml <- import(file)
#' x <- getSampleDataFromYaml(yaml)
#' summary(x)
#' colnames(x)
getSampleDataFromYaml <- function(yaml) {
    assert(is.list(yaml))
    alert("Getting sample metadata from YAML.")
    data <- .sampleYAML(yaml, keys = "metadata")
    makeSampleData(data)
}