Type:	Package
Version:	1.2.14
Date:	2025-06-27
Title:	Tools for Wikidata and Wikipedia
Description:	A set of wrappers intended to check, read and download information from the Wikimedia sources. It is specifically created to work with names of celebrities, in which case their information and statistics can be downloaded. Additionally, it also builds links and snippets to use in combination with the function gallery() in netCoin package.
License:	GPL-3
Depends:	R (≥ 3.5.0)
Encoding:	UTF-8
Imports:	curl, httr, jsonlite, ratelimitr, collections, netCoin
Suggests:	knitr, rmarkdown
VignetteBuilder:	knitr
NeedsCompilation:	no
Maintainer:	Modesto Escobar <modesto@usal.es>
RoxygenNote:	7.3.2
Acknowledgments:	Grants CSO2013-49278-EXP, PGC2018-093755-B100, PDC2022-133355-100, PID2023-147358NB-100 funded by MICIU/AEI/10.13039/501100011033 and by “European Union NextGenerationEU/PRTR”.
Packaged:	2025-07-11 15:44:37 UTC; modes
Author:	Modesto Escobar [aut, cph, cre], Ángel Zazo [aut], Carlos Prieto [aut], David Barrios [aut], Cristina Calvo [aut]
Repository:	CRAN
Date/Publication:	2025-07-11 16:00:02 UTC

Converts a text separated by commas into a character vector.

Description

Converts a text separated by commas into a character vector.

Usage

cc(text, sep = ",")

Arguments

Details

Returns inside the text are omitted.

Value

A vector of the split segments of the text.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## A text with three names separated with commas is converted into a vector of length 3.
cc("Pedro Almodovar, Diego Velazquez, Salvador Dali")

Check if all Wikidata entities in entity_list have valid values

Description

Return a vector of entities with duplicates or void entities removed. A valid entity is a wikibase item (Qxxx, x is a digit) or a wikibase property (Pxxx).

Usage

checkEntities(entity_list)

Arguments

Value

The list of entities or raise an error.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

checkTitles(titles) Check if titles are valid. Return TRUE is all titles are valid, else FALSE. See https://en.wikipedia.org/wiki/Wikipedia:Page_name#Technical_restrictions_and_limitations

Description

checkTitles(titles) Check if titles are valid. Return TRUE is all titles are valid, else FALSE. See https://en.wikipedia.org/wiki/Wikipedia:Page_name#Technical_restrictions_and_limitations

Usage

checkTitles(titles)

Arguments

Execute a function in chunks.

Description

Execute the function f(x,...) in chunks of chunk-size elements each. Wikidata and Wikimedia API have limits to execute a query. Wikidata has timeout limits, Wikimedia about the number of titles or pageIds. This function executes sequentially the function f over chunks of elements to prevent errors.

Usage

doChunks(f, x, chunksize, ...)

Arguments

Value

The results of execute f using all values of x

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Extract the first paragraph of a Wikipedia article with a maximum of characters.

Description

Extract the first paragraph of a Wikipedia article with a maximum of characters.

Usage

extractWiki(
  names,
  language = c("en", "es", "fr", "de", "it"),
  plain = FALSE,
  maximum = 1000
)

Arguments

Value

a character vector with html formatted (or plain text) Wikipedia paragraphs.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## Not run: 
## Obtaining information in English Wikidata
names <- c("William Shakespeare", "Pedro Almodovar")
info <- getWikiInf(names)
info$text <- extractWiki(info$label)

## End(Not run)

Extract the extension of a file

Description

Extract the extension of a file

Usage

filext(fn)

Arguments

Details

This function extracts the extension of a vector of file names.

Value

A character vector of extension names.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## For a single item:
filext("Albert Einstein.jpg")
## You can do the same for a vector:
filext(c("Hillary Duff.png", "Britney Spears.jpg", "Avril Lavigne.tiff"))

Downloads a list of files in a specified path of the computer, and return a vector of the no-found names (if any).

Description

Downloads a list of files in a specified path of the computer, and return a vector of the no-found names (if any).

Usage

getFiles(lista, path = "./", ext = NULL)

Arguments

Details

This function allows download a file of files directly into your directory. This function needs a preexistent data frame of names and pictures' URL. It must be a list (or data.frame) with two values: "name" (specifying the names of the files) and "url" (containing the urls to the files to download).. All the errors are reported as outcomes (NULL= no errors). The files are donwload into your chosen directory.

Value

It returns a vector of errors, if any. All pictures are download into the selected directory (NULL= no errors).

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## Not run: 

## In case you want to download a file directly from an URL:

# dta <- data.frame(name = "Data", url = "https://sociocav.usal.es/me/Stata/example.dta")
# getFiles(dta, path = "./")

##  You can can also combine this function with getWikiData (among others).
## In case you want to download a picture of a person:

# A <- data.frame(name= getWikiData("Rembrandt")$label, url=getWikiData("Rembrandt")$pics)
# getFiles(A, path = "./", ext = "png")

## Or the pics of multiple authors: 

# B <- getWikiData(c("Monet", "Renoir", "Caillebotte"))
# data <- data.frame(name = B$label, url = B$pics)
# getFiles(data, path = "./", ext = NULL)

## End(Not run)

Create a data.frame with Wikidata of a vector of names.

Description

Create a data.frame with Wikidata of a vector of names.

Usage

getWikiData(names, language = "en", csv = NULL)

Arguments

Value

A data frame with personal information of the names or a csv file with the information separated by semicolons.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## Obtaining information in English Wikidata
## Not run: 
names <- c("William Shakespeare", "Pedro Almodovar")
info <- getWikiData(names)
## Obtaining information in Spanish Wikidata
d <- getWikiData(names, language="es")

## End(Not run)

Downloads a list of Wikipedia pages in a specified path of the computer, and return a vector of the no-found names (if any).

Description

Downloads a list of Wikipedia pages in a specified path of the computer, and return a vector of the no-found names (if any).

Usage

getWikiFiles(X, language = c("es", "en", "fr"), directory = "./", maxtime = 0)

Arguments

Details

This function allows download a set of Wikipedia pages into a directory of the local computer. All the errors (not found pages) are reported as outcomes (NULL= no errors). The files are donwload into your chosen directory.

Value

It returns a vector of errors, if any. All pictures are download into the selected directory (NULL= no errors).

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## Not run: 

## In case you want to download the Wikipage of a person:

# getWikiFiles("Rembrandt", dir = "./")

## Or the pics of multiple authors: 

# B <- c("Monet", "Renoir", "Caillebotte")
# getWikiFiles(B, dir = "./", language="fr")

## End(Not run)

Create a data.frame with Q's and descriptions of a vector of names.

Description

Create a data.frame with Q's and descriptions of a vector of names.

Usage

getWikiInf(names, number = 1, language = "en")

Arguments

Value

A data frame with name, Q, label and description of the names.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## Obtaining information in English Wikidata
names <- c("William Shakespeare", "Pedro Almodovar")
information <- getWikiInf(names)

## Obtaining information in Spanish Wikidata
## Not run: 
informacion <- getWikiInf(names, language="es")

## End(Not run)

httrGetJSON Retrieve responses in JSON format using httr::GET. It is a generic function to use for request these Wikimedia metrics API: https://wikimedia.org/api/rest_v1/ https://www.mediawiki.org/wiki/XTools/API/Page (xtools.wmflabs.org)

Description

httrGetJSON Retrieve responses in JSON format using httr::GET. It is a generic function to use for request these Wikimedia metrics API: https://wikimedia.org/api/rest_v1/ https://www.mediawiki.org/wiki/XTools/API/Page (xtools.wmflabs.org)

Usage

httrGetJSON(url)

Arguments

Value

A JSON response. Please check httr::stop_for_status(response)

Note

Used in m_Pageviews

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Limits the rate at which a function will execute

Description

Limits the rate at which a function will execute

Usage

limitRequester(f, n, period)

Arguments

Value

If 'f' is a single function, then a new function with the same signature and (eventual) behavior as the original function, but rate limited. If 'f' is a named list of functions, then a new list of functions with the same names and signatures, but collectively bound by a shared rate limit. Used only for WikiData Query Service (WDQS).

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

See Also

ratelimitr

Open search of a string

Description

Search string in the content of the project page using OpenSearch. Only in namespace 0. Please, see https://www.mediawiki.org/wiki/API:Opensearch for further information.

Usage

m_Opensearch(
  string,
  project = "en.wikipedia.org",
  profile = "engine_autoselect",
  redirects = "resolve"
)

Arguments

Value

A data-frame of page titles and URL returned. If error, return Null.

Note

Only for namespace 0. The function also obtains redirections for disambiguation pages.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

# Some search profiles:
df <- m_Opensearch(string='Duque de Alba', project='es.wikipedia.org',
                    profile="engine_autoselect", redirects="resolve")
df <- m_Opensearch(string='Duque de Alba', project='es.wikipedia.org', profile="strict")
df <- m_Opensearch(string='Duque de Alba', project='es.wikipedia.org', profile="fuzzy")

Get number of views of a Wikipedia article

Description

Use the Wikimedia REST API (https://wikimedia.org/api/rest_v1/) to get the number of views one article has in a Wikimedia project in a date interval (see granularity). If redirect=TRUE, then get the number of views of all articles that redirects to the article which is the destiny of actual page.

Usage

m_Pageviews(
  article,
  start,
  end,
  project = "en.wikipedia.org",
  access = "all-access",
  agent = "user",
  granularity = "monthly",
  redirects = FALSE
)

Arguments

Value

A vector with the number of visits by granularity.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

v <-  m_Pageviews(article="Cervantes", start="20230101", end="20230501",
                   project="es.wikipedia.org", granularity="monthly")
vv <- m_Pageviews(article="Cervantes", start="20230101", end="20230501",
                   project="es.wikipedia.org", granularity="monthly",
                   redirects=TRUE)

Gets various information from a Wikimedia page

Description

Obtains information in JSON format about an article in the Wikimedia project or NULL on errors. Use the wmflabs API. The XTools Page API endpoints offer data related to a single page. See https://www.mediawiki.org/wiki/XTools/API/Page. The URL of the API starts with 'https://xtools.wmcloud.org/api/page/'

Usage

m_XtoolsInfo(
  article,
  infotype = c("articleinfo", "prose", "links"),
  project = "en.wikipedia.org",
  redirects = FALSE
)

Arguments

Value

A list with the information about the article.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
x <-  m_XtoolsInfo(article="Cervantes", infotype="articleinfo", project="es.wikipedia.org")
xx <- m_XtoolsInfo(article="Cervantes", infotype="articleinfo", project="es.wikipedia.org",
                   redirects=TRUE)

y <-  m_XtoolsInfo(article="Miguel de Cervantes", infotype="links", project="es.wikipedia.org")
yy <- m_XtoolsInfo(article="Cervantes", infotype="links", project="es.wikipedia.org",
                    redirects=TRUE)
z  <- m_XtoolsInfo(article="Miguel de Cervantes", infotype="all", project="es.wikipedia.org")
zz <- m_XtoolsInfo(article="Cervantes", infotype="all", project="es.wikipedia.org",
                       redirects=TRUE)

## End(Not run)

Retrieve responses using the MediaWiki API.

Description

Use the MediaWiki API to check Wikipedia pages titles, get redirections of Wikipedia pages, get image URL of Wikipedia pages or get URL of files in Wikipedia pages

Usage

m_reqMediaWiki(
  titles,
  mode = c("wikidataEntity", "redirects", "pagePrimaryImage", "pageFiles"),
  project = "en.wikipedia.org",
  redirects = TRUE,
  exclude_ext = "svg|webp|xcf"
)

Arguments

Value

depends on the mode selected: 'wikidataEntity' Null if there is any error in response, else a data-frame with four columns: first, the original page title string, second, the normalized one, third, logical error=FALSE, if Wikidata entity exists for the page, or error=TRUE it does not, last, the Wikidata entity itself or a clarification of the error; 'redirects' A vector for each title, with all pages that are redirects to the first element; 'pagePrimaryImage' A data-frame with original titles, normalized ones, the status of the pages and the primary image of the page or NA if it does not exist; 'pageFiles' A data-frame with original titles, the normalized ones, status for the page and the URL files of the Wikipedia pages, using use "|" to separate ones) or NA if files do not exits or are excluded.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

# Note that URLdecode("a%CC%8C") is
# the letter "a" with the combining caron
df <- m_reqMediaWiki(c('Max Planck', URLdecode("a%CC%8C"), 'Max', 'Cervante', 'humanist'),
                    mode='wikidataEntity', project='en.wikipedia.org')
a <- m_reqMediaWiki(c('Cervantes', 'Planck', 'Noexiste'), mode='redirects',
                    project='es.wikipedia.org')
i <- m_reqMediaWiki(c('Max Planck', URLdecode("a%CC%8C"), 'Max', 'Cervante', 'humanist'),
                    mode='pagePrimaryImage')
f <- m_reqMediaWiki(c('Max Planck', URLdecode("a%CC%8C"), 'Max', 'Cervante', 'humanist'),
                    mode='pageFiles', exclude_ext = "svg|webp|xcf")

Convert names into a Wikipedia's iframe

Description

Convert names into a Wikipedia's iframe

Usage

nametoWikiFrame(name, language = "en")

Arguments

Details

This function adds the Wikipedia's iframe to a entry or name, i.e., "Max Weber" converts into "<iframe src=\"https://es.m.wikipedia.org/wiki/Max_Weber\" width=\"100...". It also manages different the languages of Wikipedia through the abbreviated two-letter language parameter, i.e., "en" = "english".

Value

A character vector of Wikipedia's iframes.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## When extracting a single item;
nametoWikiFrame("Computer", language = "en")

## When extracting two objetcs;
A <- c("Computer", "Operating system")
nametoWikiFrame(A)

## Same when three or more items;
B <- c("Socrates", "Plato", "Aristotle")
nametoWikiFrame(B)

Create the Wikipedia link of a name or entry.

Description

Create the Wikipedia link of a name or entry.

Usage

nametoWikiHtml(name, language = "en")

Arguments

Details

This function adds the Wikipedia's html link to a entry or name, i.e., "Max Weber" converts into "⁠<a href='https://es.wikipedia.org/wiki/Max_Weber' target='_blank'>Max Weber</a>⁠". It also manages different the languages of Wikipedia through the abbreviated two-letter language parameter, i.e., "en" = "english".

Value

A character vector of names' links.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## When extracting a single item;
nametoWikiHtml("Computer", language = "en")

## When extracting two objetcs;
A <- c("Computer", "Operating system")
nametoWikiHtml(A)
B <- c("Socrates", "Plato","Aristotle" )
nametoWikiHtml(B)

Create the Wikipedia URL of a name or entry.

Description

Create the Wikipedia URL of a name or entry.

Usage

nametoWikiURL(name, language = "en")

Arguments

Details

This function adds the Wikipedia URL to a entry or name, i.e., "Max Weber" converts into "https://es.wikipedia.org/wiki/Max_Weber". It also manages different the languages of Wikipedia thru the abbreviated two-letter language parameter, i.e., "en" = "english".

Value

A character vector of names' URLs.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## When extracting a single item;
nametoWikiURL("Computer", language = "en")

## When extracting two objetcs;
A <- c("Computer", "Operating system")
nametoWikiURL(A)

## Same when three or more items;
B <- c("Socrates", "Plato" , "Aristotle")
nametoWikiURL(B)

Return the normalized and redirect title from the response

Description

Return the normalized and the redirect title (also normalized), if any, from the query part of the JSON response of a MediaWiki search. The response of the MediaWiki API query (https://www.mediawiki.org/wiki/API:Query) includes original page titles and possibily normalized and redirected titles, if the API needs to obtain them. For a original title, this function returns them, if any.

Usage

normalizedTitle(title, q)

Arguments

Value

A vector with the normalized or redirected page title (target, also normalized) found for the title.

Create a drop-down vignette for nodes from different items (for galleries).

Description

Create a drop-down vignette for nodes from different items (for galleries).

Usage

pop_up(
  data,
  title = "name",
  title2 = NULL,
  info = TRUE,
  entity = "entity",
  links = c("wikidata", "wiki"),
  wikilangs = "en"
)

Arguments

Value

a character vector of html formatted vignettes attached to 'data' in a column named 'pop_up'.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## Not run: 
library(netCoin)
data("sociologists")
sociologists$entity <- sub(".png","",sociologists$picture)
sociologists <- pop_up(sociologists, title="name",
  title2="birth_country", entity="entity")
plot(exhibit(sociologists, label="name", ntext="pop_up"))

## End(Not run)

Reverse the order of the first and last names of every element of a vector.

Description

Reverse the order of the first and last names of every element of a vector.

Usage

preName(X)

Arguments

Details

This function reverses the order of the first and last names of the items: i.e., "Weber, Max" turns into "Max Weber".

Value

Another vector with its elements changed.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## To reconvert a single name:
preName("Weber, Max")
## It is possible to work with several items, as in here:
A <- c("Weber, Max", "Descartes, Rene", "Locke, John")
preName(A)

Uses httr package to retrieve responses using the MediaWiki API.

Description

For MediaWiki requests only user_agent is necessary in the request headers. See https://www.mediawiki.org/wiki/API:Etiquette. The standard and default output format in MediaWiki is JSON. All other formats are discouraged. The output format should always be specified using the request param "format" in the "query" request. See https://www.mediawiki.org/wiki/API:Data_formats#Output.

Usage

reqMediaWiki(
  query,
  project = "en.wikipedia.org",
  method = "GET",
  attempts = 2,
  debug = FALSE
)

Arguments

Value

The response in JSON format, raise exception on errors.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Get responses from Wikidata Query Service

Description

Retrieve responses from Wikidata Query Service (WDQS)

Usage

reqWDQS(sparql_query, format = "json", method = "GET")

Arguments

Value

The response in the format selected. Please check httr::stop_for_status(response)

Note

For short queries GET method is better, POST for long ones. Only GET queries as cached.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Find if there is a Wikipedia page of a name(s) in the selected language.

Description

Find if there is a Wikipedia page of a name(s) in the selected language.

Usage

searchWiki(
  name,
  language = c("en", "es", "fr", "it", "de", "pt", "ca"),
  all = FALSE,
  maxtime = 0
)

Arguments

Details

This function checks any page or entry in order to find if it has a Wikipedia page in a given language. It manages the different the languages of Wikipedia thru the two-letters abbreviated language parameter, i.e, "en" = "english". It is possible to check multiple languages in order of preference; in this case, only the first available language will appear as TRUE.

Value

A Boolean data frame of TRUE or FALSE.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## When you want to check an entry in a single language:
searchWiki("Manuel Vilas", language = "es")

## When you want to check an entry in several languages:
## Not run: 
searchWiki("Manuel Vilas", language = c( "en", "es", "fr", "it", "de", "pt", "ca"), all=TRUE)

## End(Not run)
## Not run: 
A<-c("Manuel Vilas", "Julia Navarro", "Rosa Montero")
searchWiki(A, language = c("en", "es", "fr", "it", "de", "pt", "ca"), all=FALSE)

## End(Not run)

Convert names of a wikiTools data frame to English or Spanish

Description

Convert names of a wikiTools data frame to English or Spanish

Usage

selectLang(dbase, fields = names(dbase), language = "en")

Arguments

Value

the input dataframe with changed names

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca

Convert an URL link to an HTML iframe.

Description

Convert an URL link to an HTML iframe.

Usage

urltoFrame(url)

Arguments

Details

This function converts an available URL direction to the corresponding HTML iframe, i.e., "https://es.wikipedia.org/wiki/Socrates" changes into "⁠<a href='https://es.wikipedia.org/wiki/Socrates' target='_blank'>Socrates</a>⁠".

Value

A character vector of HTML iframe for the given urls.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## When you have a single URL:

urltoFrame("https://es.wikipedia.org/wiki/Socrates")

## It is possible to work with a vector of URL to obtain another vector of html frames:

A <- c("https://es.wikipedia.org/wiki/Socrates", 
       "https://es.wikipedia.org/wiki/Plato", 
       "https://es.wikipedia.org/wiki/Aristotle")
urltoHtml (A)

Convert a Wikipedia URL to an HTML link

Description

Convert a Wikipedia URL to an HTML link

Usage

urltoHtml(url, text = NULL)

Arguments

Details

This function converts an available URL direction to the corresponding HTML link, i.e., "https://es.wikipedia.org/wiki/Socrates" changes into "⁠<a href='https://es.wikipedia.org/wiki/Socrates' target='_blank'>Socrates</a>⁠".

Value

A character vector of HTML links for the given urls.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## When you have a single URL:

urltoHtml("https://es.wikipedia.org/wiki/Socrates", text = "Socrates")

## It is possible to work with several items:

A <- c("https://es.wikipedia.org/wiki/Socrates", 
       "https://es.wikipedia.org/wiki/Plato", 
       "https://es.wikipedia.org/wiki/Aristotle")
urltoHtml (A, text = c("Socrates", "Plato", "Aristotle"))

## And  you can also directly extract the info from nametoWikiURL():

urltoHtml(nametoWikiURL("Plato", "en"), "Plato" )
urltoHtml(nametoWikiURL(c("Plato", "Socrates", "Aristotle"), language="en"), 
          c("Plato", "Socrates", "Aristotle"))

See https://meta.wikimedia.org/wiki/User-Agent_policy https://www.mediawiki.org/wiki/API:Etiquette

Description

See https://meta.wikimedia.org/wiki/User-Agent_policy https://www.mediawiki.org/wiki/API:Etiquette

Usage

user_agent

Format

An object of class character of length 1.

Suggests VIAF id from a name

Description

Search the name of the author from the VIAF AutoSuggest API and returns information in JSON format of the records found. Note that only returns a maximum of 10 records. Note that those records are not VIAF cluster records. A VIAF record is considered a "cluster record," which is the result of combining records from many libraries around the world into a single record.

Usage

v_AutoSuggest(author)

Arguments

Value

A data-frame with four columns from the elements "term", "score", "nametype" and "viafid" of the Autosuggest API response.

See Also

https://developer.api.oclc.org/viaf-api#/Authority%20Cluster

Examples

v_AutoSuggest('Iranzo')
v_AutoSuggest('Esparza, María')
# Four rows, only two viafid:
v_AutoSuggest('Escobar, Modesto')

Gets information from a VIAF record

Description

Returns information from the VIAF record. Note that the VIAF record musts be in JSON format.

Usage

v_Extract(viaf, info, source = NULL)

Arguments

Value

depends on the info selected: 'titles' A list with titles; 'gender' The gender of the author o NULL if not exits in the record; 'dates' The bird year and death year in format byear:dyear; 'occupations' A data-frame with sources and occupations from each source or NULL if occupations do not exist in the record; 'sources' A data-frame with text and sources; 'sourceId' A data-frame with columns text and source, or NULL if the source does no exist in the viaf record; 'wikipedias' A vector with the URL of the Wikipedias.

Gets record clusters

Description

Obtains the record cluster identified by viafid from VIAF, in the format indicated in record_format. Note that the returned record may be a VIAF cluster record or a redirect/scavenged record: the function returns the record as is.

Usage

v_GetRecord(viafid, record_format = "viaf.json")

Arguments

Value

The VIAF record cluster in the format indicated in record_format.

Run a CQL Query in VIAF

Description

Run the CQL_Query using the VIAF Search API and return a list of records found. The search string is formed using the CQL_Query syntax of the API. Note that returned records use the "info:srw/schema/1/JSON" record schema, i.e., are complete cluster records packed in JSON format. If the number of records found is greater than 250 (API restrictions), successive requests are made.

Usage

v_Search(
  CQL_Query,
  mode = c("default", "anyField", "allmainHeadingEl", "allNames", "allPersonalNames",
    "allTitle"),
  schema = c("JSON", "brief")
)

Arguments

Value

A list with the records found.

Examples

## Not run: 
## Search in any field (cql.any)
# Operator is "=": so search one or more terms:
CQL_Query <- 'cql.any = "García Iranzo, Juan"'
r <- v_Search(CQL_Query)
# r contains complete VIAF records (sometimes seen as a "cluster record",
# which is unified by combining records from many libraries around the world)
# Search in 1xx, 4xx, 5xx fields of MARC record (local.names)
# Operator is "all": search all terms
CQL_Query <- 'local.names all "Modesto Escobar"'
r <- v_Search(CQL_Query)

# Search in 100, 400, 500 fields of MARC record (local.personalNames)
# Operator is "all": search all terms
CQL_Query <- 'local.personalNames all "Modesto Escobar"'
r <- v_Search(CQL_Query)

# Search in Titles
CQL_Query <- 'local.title all "Los pronósticos electorales con encuestas"'
r <- v_Search(CQL_Query)

## End(Not run)

Find if an URL link is valid.

Description

Find if an URL link is valid.

Usage

validUrl(url, time = 2)

Arguments

Details

This function checks if a URL exists on the Internet.

Value

A boolean value of TRUE or FALSE.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

validUrl(url="https://es.wikipedia.org/wiki/Weber,_Max", time=2)

Get information about a Wikimedia entity (human or film)

Description

Get labels, descriptions and some properties of the Wikidata entities in entity_list, for person or films. If person, the information returned is about labels, descriptions, birth and death dates and places, occupations, works, education sites, awards, identifiers in some databases, Wikipedia page titles (which can be limited to the languages in the wikilangs parameter, etc. If films, information is about title, directors, screenwriter, castmember, producers, etc.

Usage

w_EntityInfo(
  entity_list,
  mode = "default",
  langsorder = "",
  wikilangs = "",
  nlimit = MW_LIMIT,
  debug = FALSE
)

Arguments

Value

A data-frame with the properties of the entity. Also index is set to entity_list.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
df <- w_EntityInfo(entity_list='Q134644', langsorder='es|en')
df <- w_EntityInfo(entity_list='Q134644', langsorder='es|en', wikilangs='es|en|fr')
df <- w_EntityInfo(c('Q270510', 'Q1675466', 'Q24871'), mode='film',
                   langsorder='es|en', wikilangs='es|en|fr')
# Search string 'abba' inlabel
w <- w_SearchByLabel('abba', mode='inlabel', langsorder = '', instanceof = 'Q5')
df <- w_EntityInfo(w$entity, langsorder='en', wikilangs='en|es|fr', debug='info')
# Search 3D films
w <- w_SearchByInstanceof(instanceof='Q229390', langsorder = 'en|es', debug = 'info')
df <- w_EntityInfo(w$entity, mode="film", langsorder='en', wikilangs='en', debug='info')

## End(Not run)

Extract the first paragraph of a Wikipedia article with a maximum of characters.

Description

Extract the first paragraph of a Wikipedia article with a maximum of characters.

Usage

w_Exhibit(
  entities,
  mode = "default",
  langsorder = "en",
  wikilangs = langsorder,
  links = c("wikidata", "wiki", "BNE", "RAH", "ISNI"),
  info = FALSE,
  imgpath = NULL,
  nlimit = MW_LIMIT,
  debug = FALSE,
  ...
)

Arguments

Value

An object of gallery_rd3 class.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

## Not run: 
## Obtaining information in English Wikidata
names <- c("William Shakespeare", "Pedro Almodovar")
info <- getWikiInf(names)
w_Exhibit(info$Q)

## End(Not run)

Get Latitude and Longitude coordinates, and Country of places

Description

Get Latitude and Longitude coordinates of the Wikidata entities which are places. Also the countries they belong are returned.

Usage

w_Geoloc(entity_list, langsorder = "", nlimit = 1000, debug = FALSE)

Arguments

Value

A data-frame with 'entity', label, Latitude and Longitude, country and label of the country.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
w_Geoloc(c("Q57860", "Q90", "Q15695"), langsorder="")
w_Geoloc(c("Q57860", "Q90", "Q15695"), langsorder="se") # Note label of place for Q15695
w_Geoloc(c("Q57860", "Q90", "Q15695"), langsorder="se|fr")
df <- w_SearchByOccupation(Qoc='Q2306091') # aprox. 20000
l <- df$entity
# Get birth-place (P19)
p <- w_Property(l, Pproperty = 'P19', includeQ=TRUE, langsorder='es|en', debug='info')
# Filter entities that have places
places <- p[grepl("^Q\\d+$", p$P19), ]$P19
g <- w_Geoloc(places, langsorder='en|es', debug='info')

## End(Not run)

Return label and/or descriptions of Wikidata entities

Description

Return label and/or descriptions of the entities in entity_list in language indicated in langsorder. Note that entities can be Wikidata entities (Qxxx) or Wikidata properties (Pxxx).

Usage

w_LabelDesc(
  entity_list,
  what = "LD",
  langsorder = "en",
  nlimit = 25000,
  debug = FALSE
)

Arguments

Value

A data-frame with one column for the entities, and others for the language and the labels and/or descriptions. The index of the dataframe is also set to the entity list.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
w_LabelDesc(c("Q57860", "Q712609", "Q381800", "P569"), what='LD', langsorder = 'se|es|en')

## End(Not run)

Get properties of Wikidata entities

Description

Search the entities of the entity_list for property or properties. If searched properties can have more than one language, then the parameter langsorder set the order of language used. If parameter includeQ is TRUE, also is returned the Wikidata entities for the properties. The Wikidata class of which the entities are instances of are returned too. Duplicated entities are deleted before search. Index of the data-frame is also set to entity_list.

Usage

w_Property(
  entity_list,
  Pproperty,
  includeQ = FALSE,
  langsorder = "en",
  nlimit = 10000,
  debug = FALSE
)

Arguments

Value

A data-frame with the entity, the entities of the properties and the labels in langsorder for them.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
w_Property(c("Q1252859", "Q712609", "Q381800"), Pproperty='P21|P569|P214', langsorder='en|es')
# Large list
df <- w_SearchByOccupation(Qoc='Q2306091') # ~ 20000
l <- df$entity
p <- w_Property(l, Pproperty='P21|P569|P214', langsorder='es|en', debug='info')
# Get birth-place (P19)
p <- w_Property(l, Pproperty='P19', langsorder='es|en', includeQ=TRUE, debug='info')

## End(Not run)

Get entities that have identifier in a database or authorities' catalog.

Description

Get all Wikidata entities that have identifier in the database or authorities' catalog indicated in the parameter Pauthority. Returns the Wikidata entities. If parameter langsorder=”, then no labels or descriptions of the entities are returned, otherwise the function returns them in the language order indicated in langsorder. Filtering is possible if parameter instanceof!=”. If only the number of entities which have identifier in the database or authorities' catalog is needed, set debug='count'.

Usage

w_SearchByAuthority(
  Pauthority,
  langsorder = "",
  instanceof = "",
  nlimit = 10000,
  debug = FALSE
)

Arguments

Value

A data-frame with columns: 'entity', 'entityLabel', 'entityDescription', 'instanceof', instanceofLabel' and the identifier in the "Pauthority" database. Index of the data-frame is also set to the list of entities found.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
# Example: Pauthority=P4439 (has identifier in the Museo Nacional Centro de
# Arte Reina Sofía)
w_SearchByAuthority(Pauthority="P4439", debug='count')
mncars <- w_SearchByAuthority(Pauthority="P4439")
mncars <- w_SearchByAuthority(Pauthority="MNCARS", langsorder = 'es|en')
# Wikidata entities are not 'human' (Q5):
mncars[!grepl("\\bQ5\\b", mncars$instanceof), ]
# Wikidata entities are 'human' (Q5):
mncars <- w_SearchByAuthority(Pauthority="MNCARS", langsorder = 'es|en', instanceof='Q5')

## End(Not run)

Search for entities that may match identifiers in a database or authorities' catalog.

Description

The identifiers are in id_list. The database or authorities' catalog to which these identifiers belong must be provided in parameter Pauthority. If parameter langsorder=”, then no labels or descriptions of the entities are returned, otherwise the function returns them in the language order indicated in langsorder. Duplicated entities are deleted before search. Index of the data-frame returned are also set to id_list.

Usage

w_SearchByIdentifiers(
  id_list,
  Pauthority,
  langsorder = "",
  nlimit = 3000,
  debug = FALSE
)

Arguments

Value

A data-frame with columns: 'entity', 'entityLabel', 'entityDescription', 'instanceof', instanceofLabel' and the identifier in the "Pauthority" database. Index of the data-frame is also set to the list of entities found.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
w_SearchByIdentifiers(c("4938246", "36092166", "40787112"), Pauthority='P214')
w_SearchByIdentifiers(c("4938246", "36092166", "40787112"), Pauthority='P214', langsorder='en|fr')

## End(Not run)

Get entities which are instance of a Wikidata entity

Description

Get all Wikidata entities which are instance of one o more Wikidata entities like films, cities, etc. If parameter langsorder=”, then no labels or descriptions of the entities are returned, otherwise the function returns them in the language order indicated in langsorder.

Usage

w_SearchByInstanceof(instanceof, langsorder = "", nlimit = 2500, debug = FALSE)

Arguments

Value

A data-frame. Index of the data-frame is also set to the list of entities found.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
w <- w_SearchByInstanceof('Q229390|Q25110269', langsorder = 'es|en')
w <- w_SearchByInstanceof('Q229390&Q25110269', langsorder = 'es|en')

## End(Not run)

Search Wikidata entities by string (usually labels)

Description

Search Wikidata entities in label and altLabel ("Also known as") or in any part of the entity using different approaches.

Usage

w_SearchByLabel(
  string,
  mode = "inlabel",
  langs = "",
  langsorder = "",
  instanceof = "",
  Pproperty = "",
  debug = FALSE
)

Arguments

Value

A data-frame with 'entity', 'entityLabel', 'entityDescription', (including 'instance', 'instanceLabel', 'altLabel' if mode="startswith") and additionally the properties of Pproperty.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
df <- w_SearchByLabel(string='Iranzo', mode="exact", langs='es|en')
df <- w_SearchByLabel(string='Iranzo', mode="exact", langs='es|en',
                      langsorder='es|en', instanceof = 'Q5|Q101352')
## Search entities which label or altLabel starts with "string"
df <- w_SearchByLabel(string='Iranzo', mode='startswith', lang='en', langsorder='es|en')
## Search in any position in Label or AltLabel (diacritics and case are ignored)
df <- w_SearchByLabel(string='Iranzo', mode='inlabel', langsorder='es|en')
## Search in Chinese (Simplified) (language code: zh) in any part of entity:
df <- w_SearchByLabel(string='\u4F0A\u5170\u4f50', mode='cirrus', langsorder='es|zh|en')

## End(Not run)

Get Wikidata entities with a certain occupation

Description

Return the Wikidata entities which have the occupation indicated in Qoc, the Wikidata entity for that occupation. For example, if Qoc='Q2306091', returns the Wikidata entities which occupation is "Sociologist", among others. Also returns the Wikidata class of which the entities are instances of. If parameter langsorder=”, then no labels or descriptions of the entities are returned, otherwise the function returns them in the language order indicated in langsorder. If wikilangs=” (if mode='wikipedias') then the Wikipedia pages are not filtered by language, else only Wikipedias of languages in this parameter are returned.

Usage

w_SearchByOccupation(
  Qoc,
  mode = c("default", "count", "wikipedias"),
  langsorder = "",
  wikilangs = "",
  nlimit = 10000,
  debug = FALSE
)

Arguments

Value

A data-frame with 'entity' and 'entityLabel', 'entityDescription', 'instanceof' and 'instanceofLabel' columns. Index of the data-frame is also set to the list of entities found.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
# "Q2306091" Qoc for Sociologist
w_SearchByOccupation(Qoc="Q2306091", mode='count')
q <- w_SearchByOccupation(Qoc="Q2306091", langsorder="")
q <- w_SearchByOccupation(Qoc="Q2306091", langsorder="en|es|fr")
q <- w_SearchByOccupation(Qoc="Q2306091", mode='wikipedias', debug='info')
q <- w_SearchByOccupation(Qoc="Q2306091", mode='wikipedias', wikilangs='en|es|fr', debug='info')

## End(Not run)

Get Wikipedia pages of Wikidata entities

Description

Get from Wikidata all Wikipedia page titles and URL of the Wikidata entities in entity_list. If parameter wikilangs=”, then returns all Wikipedia page titles, else only the languages in wikilangs. The returned dataframe also includes the Wikidata entity classes of which the searched entity is an instance. If set the parameter instanceof, then only returns the pages for Wikidata entities which are instances of the Wikidata class indicated in it. The data-frame doesn't return labels or descriptions about entities: the function w_LabelDesc can be used for this. Duplicated entities are deleted before search. Index of the data-frame returned are also set to entity_list.

Usage

w_Wikipedias(
  entity_list,
  wikilangs = "",
  instanceof = "",
  nlimit = 1500,
  debug = FALSE
)

Arguments

Value

A data-frame with five columns: entities, instanceof, npages, page titles and page URLs. Last three use "|" as separator. Index of data-frame is also set to the entity_list.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
# aux: get a vector of entities (l).
df <- w_SearchByLabel(string='Napoleon', langsorder='en', mode='inlabel')
l <- df$entity  # aprox. 3600

w <- w_Wikipedias(entity_list=l, debug='info')
w <- w_Wikipedias(entity_list=l, wikilangs='es|en|fr', debug='info')
# Filter instanceof=Q5 (human):
w_Q5 <- w[grepl("\\bQ5\\b", w$instanceof), ]
w_Q5b <- w_Wikipedias(entity_list=l, wikilangs='es|en|fr', instanceof='Q5', debug='info')

## End(Not run)

Check if a Wikidata entity is an instance of a class

Description

Check using WDQS if the Wikidata entities in entity_list are instances of instanceof Wikidata entity class. For example, if instanceof="Q5", check if entities are instances of the Wikidata entity class Q5, i.e, are humans. Some entity classes are allowed, separately by '|'; in this case, the OR operator is considered. If instanceof=” then no filter is applied: the function returns all Wikidata entities class of which each of the entities in the list are instances. Duplicated entities are deleted before search. Note that no labels or descriptions of the entities are returned. Please, use function w_LabelDesc for this.

Usage

w_isInstanceOf(entity_list, instanceof = "", nlimit = 50000, debug = FALSE)

Arguments

Value

A data-frame with three columns, first Wikidata entity, second all Wikidata class each instance is instance of them, last TRUE or FALSE if each entity is instance of the instanceof parameter, if this one is set.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
# aux: get a vector of entities (l).
df <- w_SearchByLabel(string='Iranzo', langsorder='es|en', mode='inlabel')
l <- df$entity

df <- w_isInstanceOf(entity_list=l, instanceof='Q5')
# Not TRUE
df[!df$instanceof_Q5,]

## End(Not run)

Check if Wikidata entities are valid

Description

A entity is valid if it has a label or has a description. If one entity exists but is not valid, is possible that it has a redirection to other entity, in that case, the redirection is obtained. Other entities may have existed in the past, but have been deleted. The returned dataframe also includes the Wikidata class (another Wikidata entity) of which the searched entity are instances of. The data-frame no contains labels or descriptions about entities: the function w_LabelDesc can be used for valid entities. Duplicated entities are deleted before search. Index of the data-frame returned are also set to entity_list.

Usage

w_isValid(entity_list, nlimit = 50000, debug = FALSE)

Arguments

Value

A data-frame with four columns: entity, valid (TRUE or FALSE), instanceof and redirection (if the entity redirects to another Wikidata entity, the redirection column contains the last).

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca

Examples

## Not run: 
w_isValid(c("Q9021", "Q115637688", "Q105660123"))
# Large list
l  <- w_SearchByOccupation(Qoc='Q2306091')
l2 <- append(l$entity, c("Q115637688", "Q105660123"))  # Note: adding two new entities
v <- w_isValid(l2)
# Not valid
v[!v$valid, ]

## End(Not run)

Response from Wikidata Query Service

Description

Retrieve responses from Wikidata Query Service (WDQS). Uses ratelimitr if param limitRequester = TRUE.

Usage

w_query(sparql_query, format = "csv", method = "GET", limitRequester = FALSE)

Arguments

Value

The response in selected format or NULL on errors.

Author(s)

Angel Zazo, Department of Computer Science and Automatics, University of Salamanca