kwr_classify: Classifies queries based on recipes in a YAML file

View source: R/classify.R

kwr_classifyR Documentation

Classifies queries based on recipes in a YAML file

Description

Classifies queries based on recipes in a YAML file

Usage

kwr_classify(kwr, recipe_file = NULL, quiet = FALSE)

Arguments

kwr

A kwresearch object containing queries to be classified.

recipe_file

A path to a recipe file in YAML format.

quiet

If TRUE, prints no messages.

Value

A kwresearch object in which the queries are classified according to the recipes in the provided YAML file. Any previous classification is preserved or updated.

Examples

queries <- data.frame(
  query = c("seo", "keyword research"),
  volume = c(1000, 500)
)
kwr <- kwresearch(queries)

recipe_file <- file.path(tempdir(), "my-recipes.yml")
kwr_add_pattern(
  pattern = "seo",
  recipe_file = recipe_file,
  recipe_type = "label",
  dim_name = "my_label"
)
kwr <- kwr_classify(kwr, recipe_file)
kwr_queries(kwr)

file.remove(recipe_file)

MarekProkop/keywordr documentation built on Nov. 6, 2022, 11:31 a.m.