wx_total_pages: Total pages counts

In bearloga/waxer: API Client Library for 'Wikimedia Analytics Query Service (AQS)'

Description

Number of total pages for a given project and timespan. This is a convenience function that combines wx_new_pages and base::cumsum.

Usage

wx_total_pages(
  project,
  editor_type = c("all", "anonymous", "user", "bot", "bot group"),
  page_type = c("all", "content", "non-content"),
  granularity = c("daily", "monthly"),
  start_date = "20191101",
  end_date = "20200101"
)

Arguments

project	The name of any Wikimedia project formatted like {language code}.{project name}, for example en.wikipedia. You may pass en.wikipedia.org and the .org will be stripped off. For projects like Wikimedia Commons (without language codes), use commons.wikimedia. For projects like www.mediawiki.org, you can use that full string, or just use mediawiki or mediawiki.org.
editor_type	If you want to filter by editor-type, use one of "anonymous", "group-bot" (registered accounts belonging to the bot group), "name-bot" (registered accounts not belonging to the bot group but having bot-like names) or "user" (registered account not in bot group nor having bot-like name). If you are interested in edits regardless of their editor type, use "all-editor-types" (default).
page_type	If you want to filter by page-type, use one of: "content" (edits made in content namespaces) or "non-content" (edits made in non-content namespaces). If you are interested in editors regardless of their page type, use "all" (default).
granularity	The time unit for the response data. As of today, supported values are daily (default) and monthly.
start_date	The date of the first day to include, in YYYYMMDD format. Can also be a Date or a POSIXt object, which will be auto-formatted.
end_date	The date of the last day to include, in YYYYMMDD format. Can also be a Date or a POSIXt object, which will be auto-formatted.

Details

Since there is no endpoint for this metric and it must be derived from the new pages metric by taking its cumulative value, this function calls wx_new_pages with start_date = 2000-01-01 so that it can correctly calculate cumulative number of pages from the very beginning of project. Then it crops the results to start with the actual provided start_date.

Value

A tibble data frame with the following columns:

project

project

date

Date

total_pages

Number of total (new + existing) pages

,

existing_pages

Number of pages already in project

,

new_pages

Number of new pages created

License

Data retrieved from the API endpoint is available under the CC0 1.0 license.

See Also

Other content data & metrics: wx_edited_pages(), wx_mediareqs_file(), wx_mediareqs_referer(), wx_most_requested_files(), wx_new_pages(), wx_page_edits(), wx_project_edits(), wx_top_edited_pages()

Examples

## Not run: 
wx_total_pages("en.wikipedia")

## End(Not run)

bearloga/waxer documentation built on Nov. 28, 2020, 11:28 p.m.