Skip to contents

Perform simple Wikidata queries

Source: R/tw_query.R
tw_query.Rd

This function aims to facilitate only the most basic type of queries: return which items have the following property pairs. For more details on Wikidata queries, the examples in the official documentation.

Usage

tw_query(
  query,
  fields = c("item", "itemLabel", "itemDescription"),
  language = tidywikidatar::tw_get_language(),
  return_as_tw_search = TRUE,
  user_agent = tidywikidatar::tw_get_user_agent()
)

Arguments

query

A list of named vectors, or a data frame (see example and readme).

fields

A character vector of Wikidata fields. Ignored if return_as_tw_search is set to TRUE (as per default). Defaults to ("item", "itemLabel", "itemDescription")

language

Defaults to language set with tw_set_language(); if not set, "en". If more than one, can be set in order of preference, e.g. c("it", "fr", "en"). Use "all_available" to keep all languages. For available language values, see the list of available language codes in the official documentation.

Logical, defaults to TRUE. If TRUE, returns a data frame with three columns (id, label, and description) that can be piped to other tw_ functions. If FALSE, a data frame with as many columns as fields.

user_agent

Defaults to a combination of tidywikidatar and package version number. Consider customising it for the current sessions with tw_set_user_agent(), in particular if you are making many queries.

Value

A data frame

Details

Consider tw_get_all_with_p() if you want to get all items with a given property, irrespective of the value.

Examples


if (interactive()) {
  query <- list(
    c(p = "P106", q = "Q1397808"),
    c(p = "P21", q = "Q6581072")
  )
  tw_query(query)
}