rKolada (version 0.2.3)

kpi_search: Search for Kolada KPIs using a Kolada KPI table

Description

Search a Kolada KPI metadata table. Only keep rows that contain the search query. Matches against all columns or columns named with the column parameter. For more precise matching, please use dplyr::filter.

Usage

kpi_search(kpi_df, query, column = NULL)

Value

A Kolada KPI metadata table

Arguments

kpi_df

A Kolada KPI metadata table, e.g. as created by get_kpi.

query

A search term or a vector of search terms to filter by. Case insensitive.

column

(Optional) A string or character vector with the names of columns in which to search for query.

Examples

if (kolada_available()) {
# Search for a single search term in a KPI table
kpis <- get_kpi(id = c("N11002", "N11003", "N11004", "N11005"))
kpi_filter <- kpi_search(kpis, "kostnad")

# Add keywords to a KPI table and search for multiple terms among
# the keywords
kpi_filter <- get_kpi(id = c("N11002", "N11003", "N11004", "N11005")) %>%
  kpi_bind_keywords(n = 3) %>%
  kpi_search(
    query = c("nettokostnad", "öppen"),
    column = c("keyword_1", "keyword_2", "keyword_3")
  )
}