Get Wikidata property of one or more items as a tidy data frame
Source:R/tw_get_property.R
tw_get_property.RdGet Wikidata property of one or more items as a tidy data frame
Usage
tw_get_property(
id,
p,
language = tidywikidatar::tw_get_language(),
id_df = NULL,
cache = NULL,
overwrite_cache = FALSE,
cache_connection = NULL,
disconnect_db = TRUE,
wait = 0
)Arguments
- id
A character vector, must start with Q, e.g. "Q180099" for the anthropologist Margaret Mead. Can also be a data frame of one row, typically generated with
tw_search()or a combination oftw_search()andtw_filter_first().- p
A character vector, a property. Must always start with the capital letter "P", e.g. "P31" for "instance of".
- language
Defaults to language set with
tw_set_language(); if not set, "en". Use "all_available" to keep all languages. For available language values, see the dedicated Wikimedia page.- id_df
Default to
NULL. If given, it should be a dataframe typically generated withtw_get(), and is used instead of calling Wikidata or using SQLite cache. Ignored whenidis of length more than one.- cache
Defaults to
NULL. If given, it should be given eitherTRUEorFALSE. Typically set withtw_enable_cache()ortw_disable_cache().- overwrite_cache
Logical, defaults to
FALSE. IfTRUE, it overwrites the table in the local sqlite database. Useful if the original Wikidata object has been updated.- cache_connection
Defaults to
NULL. IfNULL, and caching is enabled,tidywikidatarwill use a local sqlite database. A custom connection to other databases can be given (see vignettecachingfor details).- disconnect_db
Defaults to
TRUE. IfFALSE, leaves the connection to cache open.- 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.
Value
A tibble, corresponding to the value for the given property. A tibble of zero rows if no relevant property found.
Examples
# Who were the doctoral advisors - P184 - of Margaret Mead - Q180099?
advisors <- tw_get_property(id = "Q180099", p = "P184")
advisors
#> # A tibble: 2 × 4
#> id property value rank
#> <chr> <chr> <chr> <chr>
#> 1 Q180099 P184 Q228822 normal
#> 2 Q180099 P184 Q76857 normal
# tw_get_label(advisors)
# It is also possible to get one property for many id
if (interactive()) {
tw_get_property(
id = c(
"Q180099",
"Q228822"
),
p = "P31"
)
# Or many properties for a single id
tw_get_property(
id = "Q180099",
p = c("P21", "P31")
)
}