page_backlinks: Retrieve a page's backlinks

View source: R/metadata.R

page_backlinksR Documentation

Description

page_backlinks, when provided with a page title, retrieves backlinks to that page. Output can be filtered to specific namespaces.

Usage

page_backlinks(
  language = NULL,
  project = NULL,
  domain = NULL,
  page,
  limit = 50,
  direction = "ascending",
  namespaces = NULL,
  clean_response = FALSE,
  ...
)

Arguments

language

The language code of the project you wish to query, if appropriate.

project

The project you wish to query ("wikiquote"), if appropriate. Should be provided in conjunction with language.

domain

as an alternative to a language and project combination, you can also provide a domain ("rationalwiki.org") to the URL constructor, allowing for the querying of non-Wikimedia MediaWiki instances.

page

the title of the page you want the backlinks of.

limit

the number of backlinks to return. Set to 50 (the maximum) by default.

direction

the direction to order the backlinks in, by linking page ID: "ascending" or "descending". Set to "ascending" by default.

namespaces

The namespaces to filter to. By default, backlinks from any namespace are retrieved: alternately, a numeric vector of accepted namespaces (which are described here) can be provided, and only backlinks from pages within those namespaces will be returned.

clean_response

whether to do some basic sanitising of the resulting data structure. Set to FALSE by default.

...

further arguments to pass to httr's GET.

Warnings

as with pages_in_category, if the page you are linking to does not exist, an empty list will be returned, without any indication of an error.

Examples

## Not run: 
#Backlink
all_bls <- page_backlinks("en","wikipedia", page = "Aaron Halfaker")

#Namespace-specific backlinks
mainspace_bls <- page_backlinks("en","wikipedia", page = "Aaron Halfaker", namespaces = 0)

## End(Not run)

WikipediR documentation built on June 22, 2024, 12:01 p.m.