get_info: Information on available SUNGEO data files

View source: R/get_info.R

get_infoR Documentation

Information on available SUNGEO data files

Description

This function reports the availability of data files on the SUNGEO server, searchable by country and topic.

Usage

get_info(country_names = NULL, country_iso3s = NULL, topics = NULL)

Arguments

country_names

Country name(s). Character string (single country) or vector of character strings (multiple countries).

country_iso3s

Country code (ISO 3166-1 alpha-3). Character string (single country) or vector of character strings (multiple countries).

topics

Data topics. See get_info() for full list. Character string (single topic) or vector of character strings (multiple topics).

Value

list object, with three slots: 'summary', 'topics', and 'geoset'.

See Also

get_data

Examples

# Get list of all available data
## Not run: 
out_1 <- get_info()
out_1["summary"]
out_1["topics"]
out_1["geosets"]

## End(Not run)

# Get list of available data for a single country
## Not run: 
out_2 <- get_info(country_names="Afghanistan")
out_2

## End(Not run)

# Get list of available data for a single topic
## Not run: 
out_3 <- get_info(topics="Elections:LowerHouse:CLEA")
out_3

## End(Not run)

# Get list of available data for a multiple countries and topics
## Not run: 
out_4 <- get_info(
                 country_names=c("Afghanistan","Zambia"),
                 topics=c("Elections:LowerHouse:CLEA","Events:PoliticalViolence:GED"))
out_4

## End(Not run)

SUNGEO documentation built on Nov. 4, 2023, 1:07 a.m.