openPolandSearch: Search openPoland.net database for a specific dataset.

Description Usage Arguments Details Value See Also Examples

Description

openPolandSearch returns a data frame with information of available datasets that were found with a given quary.

Usage

1
openPolandSearch(query = NULL, token = NULL, subQuery = NULL)

Arguments

query

A character string.

token

A character string.

subQuery

A characters string.

Details

The query from openPolandSearch function is not case-sensitive. The token authorization is non-obligatory for database searching. Polish diacritics should also worked within a query. The query parameter is send to API, but the subQuery parameter is search locally after downloading the dataset lists from API.

Value

A data table object with datasets ids and titles that have a query string inside them.

See Also

openPolandMeta for meta data about datasets, openPolandData for downloading a selected dataset via openPoland API, and openPolandFilter for filtering locally downloaded dataset with given criterias.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
openPolandSearch() # returns list of all datasets

openPolandSearch(query = 'telef')

openPolandSearch(query = "nauczy", subQuery = "akad")

# Polish diacritics are also available but remember
# to set Polish localization first if you want to work with properly
# formated Polish titles of datasets.
Sys.setlocale("LC_ALL", "Polish")
openPolandSearch(query = 'ludno\\u015B\\u0107')

## End(Not run)

kalimu/openPoland documentation built on May 20, 2019, 6:32 a.m.