report: Set of data structure exploration functions for users

Description Usage Arguments Details Value Examples

Description

The report family of functions allows users to quickly get information about and compare several aspects of a q Packages, databases and datasets.

Usage

1
2
3
data_source(pkg, database = NULL, dataset = NULL)

data_contrast(pkg, database = NULL, dataset = NULL)

Arguments

pkg

character string of the qPackage to report data on. Required input.

database

vector of character strings of the qPackage to report data a specific database in a qPackage. If NULL, the function returns a summary of all databases in the qPackage. NULL by default for data_source() and data_contrast().

dataset

character string of the qPackage to report data on a specific dataset in a specific database of a qPackage. If NULL and database is specified, returns database level metadata. NULL by default for data_source() and data_contrast().

Details

data_source() displays names of the database/datasets and source material of qPackage data.

data_contrast() displays information about databases and datasets contained in them. Namely the number of unique ID's, the percentage of missing data, the number of observations, the number of variables, the minimum beginning date and the maximum ending date as well as the most direct URL to the original dataset.

Value

A dataframe with the data sources

A list with the desired metadata to compare various datasets in the qVerse.

Examples

1
2
data_source(pkg = "qData")
data_contrast(pkg = "qData")

globalgov/qData documentation built on July 27, 2021, 10:54 a.m.