get_datacatalog: Gets all DataCatalog records (DataCatalogs)

Description Usage Arguments Details Examples

View source: R/GetInformation.R

Description

Gets all DataCatalog records (DataCatalogs)

Usage

1
get_datacatalog(save_file = FALSE, ...)

Arguments

save_file

Logical. Choose whether or not to save the data in an external .Rdata file in the working directory. Default: FALSE.

...

Other arguments that might define the path to data. All arguments accept a numeric code which is interpreted as the code of the specific product requested. Alternatively, you can supply the equivalent product name as a string which is case insensitive (see examples). Handle with care, this is important! For a list of all options available, see the parameters for each endpoint at https://popdiv.dfs.un.org/Demodata/swagger/ui/index#/

Details

For an improved output, we combine DataCatalog data with locations (get_locations), dataprocess (get_dataprocess), dataprocesstype (get_dataprocesstype) together with some transformations (convert dates to date columns, renaming columns, etc...).

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## Not run: 

dc <- get_datacatalog()
head(dc[, c("DataCatalogID", "DataProcessType", "LocName")])

# Filter using locIds and DataProcessTypeIds
dc <- get_datacatalog(locIds = 76, dataProcessTypeIds = 2)


t2 <- get_datacatalog(isSubnational = TRUE)
head(t2)

t3 <- get_datacatalog(isSubnational = FALSE)
head(t3)


## End(Not run)

timriffe/DDSQLtools documentation built on Oct. 6, 2021, 5:34 p.m.