Help for package hlidacr

Type:

Package

Title:

Access Data from the 'Hlídač Státu' API

Version:

0.2.0

Date:

2021-09-16

Description:

Provides access to datasets published by 'Hlídač státu' https://www.hlidacstatu.cz/, a Czech watchdog, via their API.

License:

MIT + file LICENSE

URL:

https://github.com/skvrnami/hlidacr

BugReports:

https://github.com/skvrnami/hlidacr/issues

Encoding:

UTF-8

Suggests:

testthat, covr, knitr, rmarkdown, vcr

RoxygenNote:

7.1.1

Imports:

httr, jsonlite, glue, purrr, stringr, curl, usethis, urltools

VignetteBuilder:

knitr

NeedsCompilation:

Packaged:

2021-09-16 13:25:08 UTC; skvrnami

Author:

Michael Škvrňák

[aut, cre]

Maintainer:

Michael Škvrňák <michael.skvrnak@protonmail.com>

Repository:

CRAN

Date/Publication:

2021-09-16 13:40:02 UTC

Check internet connection

Description

Check internet connection

Usage

check_connection()

Value

No return value, called for side effects

Check API token

Description

Check API token

Usage

check_token(token)

Arguments

token

API token to Hlidac statu

Value

No return value, called for side effects

Check if all social media account types are valid

Description

Check if all social media account types are valid

Usage

check_types(types)

Arguments

types

Vector with types of social media accounts

Value

No return value, called for side effects

Create query string for osoby/social API endpoint

Description

Create query string for osoby/social API endpoint

Usage

create_type(types)

Arguments

types

Vector with types of social media accounts

Value

String for querying API

Get company details

Description

Get company details

Usage

get_company(company_name, token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

company_name

Name of the company

token

Access token

Value

list with 3 elements: - ico: ID number of the company - jmeno: Name of the company - datoveSchranky: Data post box - electronic repository for communication between public institutions and private companies/people

Examples

## Not run: 
get_company("Agrofert")

## End(Not run)

Get contract details

Description

Get contract details

Usage

get_contract(id, token = NULL)

Arguments

id

ID of contract

token

Authorization token

Value

list with data

Examples

## Not run: 
get_contract(id = "1086905")

## End(Not run)

Get contract text

Description

Get contract text

Usage

get_contract_text(id, token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

id

ID of contract

token

Authorization token

Value

Character vector containing text of the contract

Examples

## Not run: 
get_contract_text(id = "1086905")

## End(Not run)

Get data from the dataset

Description

Get data from the dataset

Usage

get_dataset_data(
  dataset_id,
  token = Sys.getenv("HLIDAC_TOKEN"),
  query = NULL,
  page = 1,
  sort = NULL,
  desc = NULL
)

Arguments

dataset_id

ID of dataset

token

Authorization token

query

Search query

page

Number of page (Please note that if the page parameter exceeds 200, the function returns error)

sort

Sort by column

desc

Descending or ascending sorting

Value

list containing 3 elements: - total: Total number of datasets available (integer) - page: Page of the result (integer), equal to the 'page' argument of the function - results: Data.frame with data, columns vary depending on the dataset

Examples

## Not run: 
get_dataset_data("ministri")
get_dataset_data("ministri", query = "Zeman", page = 1)

## End(Not run)

Get dataset's metadata

Description

Get metadata related to specified dataset.

Usage

get_dataset_metadata(dataset_id, token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

dataset_id

ID of dataset

token

Authorization token

Value

a list containing metadata related to the specified dataset

Examples

## Not run: 
get_dataset_metadata("ministri")

## End(Not run)

Get record detail

Description

Get record detail

Usage

get_dataset_record_detail(
  dataset_id,
  item_id,
  token = Sys.getenv("HLIDAC_TOKEN")
)

Arguments

dataset_id

ID of dataset

item_id

ID of record

token

Authorization token

Value

list of vectors containing data related to the item

Examples

## Not run: 
get_dataset_record_detail("ministri", item_id = 1)

## End(Not run)

Get list of datasets

Description

Get list of datasets available via 'Hlídač státu' API

Usage

get_datasets(token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

token

Authorization token

Value

Response from the server containing a list of all datasets available. The list contains 3 elements: - total: Total number of datasets available (integer) - page: Page of the result (integer) - results: data concerning the datasets (data.frame)

Examples

## Not run: 
get_datasets()

## End(Not run)

Get person details

Description

Get person details

Usage

get_person(person_id, token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

person_id

Person's ID

token

Access token

Value

list with the following elements: - titulPred: academic titles written before person's name - jmeno: given name - prijmeni: surname - titulPo: academic titles written after person's name (if applicable) - narozeni: date of birth - nameId: person's id - profile: URL of profile at hlidacstatu.cz - sponzoring: data.frame with data on sponsorship of political parties by the person - udalosti: events related to the person such as party membership and running in election, serving in political bodies and relations to private companies (shareholder, serving on a board) - socialniSite: data.frame with data on social media accounts

Examples

## Not run: 
get_person("andrej-babis")

## End(Not run)

Get person social media accounts

Description

Get person social media accounts

Usage

get_person_social(types, token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

types

Types of social media accounts, only the following types are allowed: 'Twitter', 'Facebook_page', 'Facebook_profile', 'Instagram', 'WWW', 'Youtube'

token

Access token

Value

data.frame with data on persons' social accounts with the following columns: - titulPred: academic titles written before person's name - jmeno: given name - prijmeni: surname - titulPo: academic titles written after person's name - nameId: person's ID - profile: URL of profile at hlidacstatu.cz - socialniSite: data.frame with data on social accounts (Type of social media, Id of the social media account, URL)

Examples

## Not run: 
get_person_social(types = c("Twitter", "Instagram"))

## End(Not run)

Get subsidy

Description

Get subsidy

Usage

get_subsidy(id, token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

id

Subsidy ID

token

Authorization token

Value

list with details of the subsidy

Examples

## Not run: 
get_subsidy("deminimis-1000229862")

## End(Not run)

Get website detail

Description

Get website detail

Usage

get_website_detail(id, token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

id

Website id

token

Authorization token

Value

list with 2 elements: - availability: data on availability of the website including response time and HTTP status code every minute - ssl: assessment of the website's SSL server configuration

Examples

## Not run: 
get_website_detail(id = "10107")

## End(Not run)

Get websites

Description

Get websites

Usage

get_websites(token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

token

Authorization token

Value

data.frame with data on websites run by the state with the following columns: - hostid: ID of website - host: host of website - url: URL of website - opendataUrl: URL to open data on website's availability - pageUrl: URL to website's profile at Hlidac statu - urad: the institution running the website - publicname: name of the website - popis: description of the website - hash

Examples

## Not run: 
get_websites()

## End(Not run)

Handle response other than 200

Description

Handle response other than 200

Usage

handle_error_response(response)

Arguments

response

Response from the server

Value

No return value, called for side effects

Search contract

Description

Search contract

Usage

search_contracts(query, token = Sys.getenv("HLIDAC_TOKEN"), page = 1, sort = 0)

Arguments

query

Full-text search query

token

Access token

page

Page of results (Please note that if the page parameter exceeds 200, the function returns error)

sort

Ordering of the results, the available options are the following: - 0: sort by relevance - 1: recently added contracts first - 2: recently added contracts last - 3: the cheapest contracts first - 4: the most expensive contracts first - 5: recently concluded contracts first - 6: recently concluded contracts last - 7: the most defective contracts first - 8: sort by purchaser - 9: sort by supplier

Value

list containing 3 elements: - Total: Total number of datasets available (integer) - Page: Page of the result (integer) - Results: Data.frame with data concerning the datasets

Examples

## Not run: 
search_contracts(query = "golf")

## End(Not run)

Search person

Description

Search person

Usage

search_person(query, page = NULL, token = Sys.getenv("HLIDAC_TOKEN"))

Arguments

query

Search query for a person, required parameter

page

Page number

token

Access token

Value

data.frame with found persons with the following columns: - jmeno: given name - prijmeni: surname - narozeni: date of birth - nameId: person's ID - profile: URL of profile at hlidacstatu.cz - titulPred: academic titles written before person's name - titulPo: academic titles written after person's name

Examples

## Not run: 
search_person(query = "Kalousek")

## End(Not run)

Search person by name and date of birth

Description

Search person by name and date of birth

Usage

search_person_by_parameters(
  first_name = NULL,
  last_name = NULL,
  birth_date = NULL,
  ignore_diacritics = TRUE,
  token = Sys.getenv("HLIDAC_TOKEN")
)

Arguments

first_name

Person's first name

last_name

Person's last name

birth_date

Person's date of birth (in YYYY-MM-DD format)

ignore_diacritics

Parameter indicating whether diacritics in names should be ignored (boolean)

token

Access token

Value

Examples

## Not run: 
search_person_by_parameters(first_name = "Miroslav", last_name = "Kalousek",
birth_date = "1960-12-17")

## End(Not run)

Search subsidies

Description

Search subsidies

Usage

search_subsidies(
  query,
  page = 1,
  sort = NULL,
  token = Sys.getenv("HLIDAC_TOKEN")
)

Arguments

query

Search query

page

Page number (Please note that if the page parameter exceeds 200, the function returns error)

sort

Sorting of results, the available options are the following: - 0: order by relevance - 1: order by the date of signature, the most recent first - 2: order by the date of signature, the most recent last - 3: order by the size of the subsidy, the largest first - 4: order by the size of the subsidy, the largest last - 5: order by ICO in a descending order - 6: order by ICO in an ascending order

token

Authorization token

Value

Examples

## Not run: 
search_subsidies("golf")

## End(Not run)

Check internet connection

Description

Usage

Value

Check API token

Description

Usage

Arguments

Value

Check if all social media account types are valid

Description

Usage

Arguments

Value

Create query string for osoby/social API endpoint

Description

Usage

Arguments

Value

Get company details

Description

Usage

Arguments

Value

See Also

Examples

Get contract details

Description

Usage

Arguments

Value

See Also

Examples

Get contract text

Description

Usage

Arguments

Value

See Also

Examples

Get data from the dataset

Description

Usage

Arguments

Value

See Also

Examples

Get dataset's metadata

Description

Usage

Arguments

Value

See Also

Examples

Get record detail

Description

Usage

Arguments

Value

See Also

Examples

Get list of datasets

Description

Usage

Arguments

Value

See Also

Examples

Get person details

Description

Usage

Arguments

Value

See Also

Examples

Get person social media accounts

Description

Usage

Arguments

Value