tw_search_item {tidywikidatar} | R Documentation |
Search for Wikidata properties in Wikidata and return Wikidata id, label, and description.
Description
This search returns only items, use tw_search_property()
for properties.
Usage
tw_search_item(
search,
language = tidywikidatar::tw_get_language(),
response_language = tidywikidatar::tw_get_language(),
limit = 10,
include_search = FALSE,
wait = 0,
cache = NULL,
overwrite_cache = FALSE,
cache_connection = NULL,
disconnect_db = TRUE
)
Arguments
search |
A string to be searched in Wikidata |
language |
Language to be used for the search. Can be set once per session with |
response_language |
Language to be used for the returned labels and descriptions. Corresponds to the |
limit |
Maximum numbers of responses to be given. |
include_search |
Logical, defaults to FALSE. If TRUE, the search is returned as an additional column. |
wait |
In seconds, defaults to 0. Time to wait between queries to Wikidata. If data are cached locally, wait time is not applied. If you are running many queries systematically you may want to add some waiting time between queries. |
cache |
Defaults to NULL. If given, it should be given either TRUE or FALSE. Typically set with |
overwrite_cache |
Defaults to FALSE. If TRUE, overwrites cache. |
cache_connection |
Defaults to NULL. If NULL, and caching is enabled, |
disconnect_db |
Defaults to TRUE. If FALSE, leaves the connection to cache open. |
Value
A data frame (a tibble) with three columns (id, label, and description), and as many rows as there are results (by default, limited to 10).
Examples
tw_search_item(search = "Sylvia Pankhurst")