Package 'ibb'

Title: R Wrapper for Istanbul Municipality Open Data Portal
Description: Call wrappers for Istanbul Metropolitan Municipality's Open Data Portal (Turkish: İstanbul Büyükşehir Belediyesi Açık Veri Portalı) at <https://data.ibb.gov.tr/en/>.
Authors: Berk Orbay [aut, cre], Emrah Er [ctb]
Maintainer: Berk Orbay <[email protected]>
License: MIT + file LICENSE
Version: 0.0.2
Built: 2025-03-06 03:02:19 UTC
Source: https://github.com/berkorbay/ibb

Help Index


Fundamental Call Function

Description

Fundamental call function of (almost) all IBB Open Data Portal (exceptions apply)

Usage

call_data_ibb(
  call_phrase = "",
  root_url = "https://data.ibb.gov.tr/api/3/action/"
)

Arguments

call_phrase

Suffix of the call url.

root_url

Root of the calls.


Change Language to English

Description

Changes API language to English

Usage

change_language_to_english()

Get All Data Sources

Description

Get All Data Sources

Usage

get_all_data_sources(get_all_info = FALSE)

Arguments

get_all_info

If TRUE return the whole list, otherwise just return the required result data frame.


Get Info on All Data Sources

Description

Get Info on All Data Sources

Usage

get_all_detailed_info(verbose = FALSE)

Arguments

verbose

If TRUE, it prints the track of the data being imported.


Get Data Frame from Resource ID Value

Description

Given a data resource ID, this function returns the data frame.

Usage

get_data_frame_ibb(resource_id, limit = "", return_json = FALSE)

Arguments

resource_id

Resource ID of the wanted data set. Run get_all_detailed_info to see the available IDs

limit

Maximum number of records

return_json

If TRUE, return a json string instead of a data frame.

Examples

## Not run: 
get_data_frame_ibb("99d1edb6-a889-4e69-be7b-21a3f90101f1")

## End(Not run)

Get Info on a Data Source

Description

Get Info on a Data Source

Usage

get_detailed_info_on_data_source(package_id, get_all_info = FALSE)

Arguments

package_id

Package ID taken from the package list. Run get_all_detailed_info to see the available IDs

get_all_info

If TRUE return the whole list, otherwise just return the required result data frame.

Examples

## Not run: 
get_detailed_info_on_data_source("594ca91d-0c71-41da-b50a-c7cd30fab67a")

## End(Not run)

Environmental Monitoring and Control Data Based on Location in 2020

Description

It contains environmental monitoring and control data with 13 parameters, measured in 15-minute periods in 38 pre-determined locations in Istanbul for 2020.

Usage

get_environmental_monitoring_and_control_data(
  params = list(limit = Sys.getenv("IBB_QUERY_LIMIT"))
)

Arguments

params

List of parameters

Examples

## Not run: 
get_environmental_monitoring_and_control_data(params = list(limit = 5))

## End(Not run)

ibbWiFi Daily Data Usage

Description

Data set contains info about number of locations, number of subscribers, number of sessions, number of devices, data usage and usage duration.

Usage

get_ibb_wifi_daily_data_usage(
  params = list(limit = Sys.getenv("IBB_QUERY_LIMIT"))
)

Arguments

params

List of parameters


ibbWiFi Daily New Subscribers

Description

Data set of new subscribers

Usage

get_ibb_wifi_daily_new_subscribers(
  params = list(limit = Sys.getenv("IBB_QUERY_LIMIT"))
)

Arguments

params

List of parameters


ibbWiFi New Subscribers by Location

Description

Data set of new subscribers by subscription location

Usage

get_ibb_wifi_new_subscribers_by_location(
  params = list(limit = Sys.getenv("IBB_QUERY_LIMIT"))
)

Arguments

params

List of parameters


Water Outage Complaints and Response Numbers by District in 2019

Description

Contains information on the number of complaints and responses to water outages and responses from all districts and neighborhoods across Istanbul in 2019, from the Istanbul Water and Sewerage Administration (İSKİ) call center.

Usage

get_iski_call_center_complaint_stats(
  params = list(limit = Sys.getenv("IBB_QUERY_LIMIT"))
)

Arguments

params

List of parameters

Examples

## Not run: 
get_iski_call_center_complaint_stats(params = list(limit = 5))

## End(Not run)

Get ISPARK Locations

Description

Get ISPARK Locations

Usage

get_ispark_locations(params = list(limit = Sys.getenv("IBB_QUERY_LIMIT")))

Arguments

params

List of parameters

Examples

## Not run: 
get_ispark_locations(params = list(limit = 5))

## End(Not run)

Park, Garden and Green Area Data for 2019

Description

Includes the number of parks, number of trees maintained, number of sports grounds, length of sports fields, number of playgrounds, number of trees planted, and type of green areas in Istanbul in 2019.

Usage

get_park_garden_green_area_data(
  params = list(limit = Sys.getenv("IBB_QUERY_LIMIT"))
)

Arguments

params

List of parameters

Examples

## Not run: 
get_park_garden_green_area_data(params = list(limit = 5))

## End(Not run)

List of Data Sources

Description

Data frame containing all resource ids and data sources of IBB Open Data Portal

Usage

ibb_data_sources

Format

An object of class tbl_df (inherits from tbl, data.frame) with 205 rows and 23 columns.


Set Query Limit

Description

Sets maximum number of returned results

Usage

set_query_limit(limit = 100)

Arguments

limit

Limit of the maximum results