info_xSub: Information on available xSub files

View source: R/info_xSub.R

info_xSubR Documentation

Information on available xSub files

Description

This function reports the availability of files on the www.x-sub.org server, and corresponding country codes and units of analysis. For additional info, see www.x-sub.org/about/what-is-xsub.

Usage

info_xSub(
  details = FALSE,
  sources_type = "individual",
  data_type = "panel",
  data_source = NULL,
  country_iso3 = NULL,
  country_name = NULL,
  geo_window = NULL,
  time_window = NULL,
  dyad_type = NULL
)

Arguments

details

Logical. If details=TRUE, function returns information on available units of analysis for each country.

sources_type

Type of data sources ("individual" or "multiple"). Character string.

data_type

Type of dataset ("event" or "panel"). Character string.

data_source

Subset results by data sources. Character string or vector.

country_iso3

Subset results by country codes (ISO3). Character string or vector.

country_name

Subset results by country name. Character string or vector.

geo_window

Geographic window (if source_type="multiple"). Could be either of "1 km" or "5 km". Character string or vector.

time_window

Time window (if source_type="multiple"). Could be either of "1 day" or "2 day". Character string or vector.

dyad_type

Time window (if source_type="multiple"). Could be either of "undirected" or "directed". Character string or vector.

See Also

get_xSub, get_xSub_multi

Examples

# General info on data sources and countries
info_xSub()

# Available files for Pakistan
info_xSub(country_name = "Pakistan")

# Detailed info for Pakistan
info_xSub(details=TRUE,country_name = "Pakistan")

# Available files for SCAD data source
info_xSub(data_source = "SCAD")

# Available files for SCAD data source, event-level
info_xSub(data_source = "SCAD", data_type = "event")

# Multiple data sources, directed dyads
info_xSub(sources_type = "multiple", dyad_type = "directed")

# Multiple data sources, directed dyads, Russia
info_xSub(sources_type = "multiple", dyad_type = "directed", country_name = "Russia")

xSub documentation built on June 30, 2022, 5:05 p.m.