,
Leo Lahti [aut] | Title: | R Tools for Helsinki Open Data |
|---|---|
| Description: | Tools for accessing various open data APIs in the Helsinki region in Finland. Current data sources include the Service Map API, Linked Events API, and Helsinki Region Infoshare statistics API. |
| Authors: | Juuso Parkkinen [aut, cre],
Joona Lehtomaki [aut],
Pyry Kantanen [aut] ,
Leo Lahti [aut] |
| Maintainer: | Juuso Parkkinen <[email protected]> |
| License: | BSD_2_clause + file LICENSE |
| Version: | 1.0.6 |
| Built: | 2024-09-05 02:51:50 UTC |
| Source: | https://github.com/rOpenGov/helsinki |
Brief summary of the helsinki package
| Package: | helsinki |
| Type: | Package |
| Version: | See sessionInfo() or DESCRIPTION file |
| Date: | 2013-2022 |
| License: | BSD-2-Clause |
Tools for accessing various open data sources in the Helsinki region in Finland.
Juuso Parkkinen, Leo Lahti, Joona Lehtomaki and Pyry Kantanen [email protected]
See citation("helsinki") https://github.com/rOpenGov/helsinki
# library(helsinki)# library(helsinki)
Sf object of city districts in the Helsinki Capital Region.
get_city_map(city = NULL, level = NULL, ...)get_city_map(city = NULL, level = NULL, ...)
city |
The desired city. Valid options: Helsinki, Espoo, Vantaa, Kauniainen |
level |
The desired administrative level. Valid options: suurpiiri, tilastoalue, pienalue and aanestysalue |
... |
For passing parameters to embedded functions, for example timeout.s (timeout in seconds) in the case of gracefully_fail() internal function |
See get_feature_list() for a list of all available features
sf object
Pyry Kantanen [email protected]
Metropolitan area in districts: https://hri.fi/data/en_GB/dataset/seutukartta
## Not run: map <- get_city_map(city = "helsinki", level = "suuralue") ## End(Not run)## Not run: map <- get_city_map(city = "helsinki", level = "suuralue") ## End(Not run)
Produces an sf object for easy visualization
get_feature( base.url = "https://kartta.hsy.fi/geoserver/wfs", typename = "asuminen_ja_maankaytto:Vaestotietoruudukko_2015", CRS = 3879 )get_feature( base.url = "https://kartta.hsy.fi/geoserver/wfs", typename = "asuminen_ja_maankaytto:Vaestotietoruudukko_2015", CRS = 3879 )
base.url |
WFS url, for example "https://kartta.hsy.fi/geoserver/wfs" |
typename |
accepts feature names, e.g. "asuminen_ja_maankaytto:1000m_verkostobufferi" No short form titles here, e.g. "1000m_verkostobufferi"! |
CRS |
Default CRS is 3879 (or EPSG:3879), see ?sf::st_crs for other input options |
sf object
Pyry Kantanen [email protected]
Use get_feature_list to list all available features
for a given WFS, select_feature for listing and selecting a
feature
Basically a neat wrapper for "request=GetCapabilities".
get_feature_list(base.url = NULL, queries = c(request = "GetCapabilities"))get_feature_list(base.url = NULL, queries = c(request = "GetCapabilities"))
base.url |
WFS url, for example "https://kartta.hsy.fi/geoserver/wfs" |
queries |
desired query for acquiring the list of features, default is "request=GetCapabilities" |
Lists all <FeatureType> nodes.
data frame
Pyry Kantanen [email protected]
Use get_feature() to download feature,
select_feature() for menu-driven listing and downloading
## Not run: dat <- get_feature_list(base.url = "https://kartta.hsy.fi/geoserver/wfs") ## End(Not run)## Not run: dat <- get_feature_list(base.url = "https://kartta.hsy.fi/geoserver/wfs") ## End(Not run)
Retrieves data from the Helsinki Region Infoshare (HRI) statistics API: http://dev.hel.fi/stats/. Currently provides access to the aluesarjat data: https://stat.hel.fi/pxweb/fi/Aluesarjat/.
get_hri_stats(query = "", verbose = TRUE)get_hri_stats(query = "", verbose = TRUE)
query |
A string, specifying the dataset to query |
verbose |
logical. Should R report extra information on progress? Default is TRUE |
Current implementation is very simple. You can either get the list of resources with query="", or query for a specific resources and retrieve it in a three-dimensional array form.
multi-dimensional array
Juuso Parkkinen [email protected]
See citation("helsinki")
See https://dev.hel.fi/apis/statistics/dev.hel.fi website and http://dev.hel.fi/stats/API documentation (in Finnish)
## Not run: stats_array <- get_hri_stats("aluesarjat_a03s_hki_vakiluku_aidinkieli") ## End(Not run)## Not run: stats_array <- get_hri_stats("aluesarjat_a03s_hki_vakiluku_aidinkieli") ## End(Not run)
Easy access to Helsinki Linked Events API
get_linkedevents(query, ...)get_linkedevents(query, ...)
query |
The API query as a string, for example "event", "category", "language", "place" or "keyword". |
... |
Additional parameters that narrow down the output (optional). |
Complete list of possible query input: "keyword", "keyword_set", "place", "language", "organization", "image", "event", "search", "user".
With "..." the user can pass on additional parameters that depend on the chosen query input. For example, when performing a search (query = "search"), the search can be narrowed down with parameters such as:
q="konsertti" complete search, returns events that have the word "konsertti"
input="konse" partial search, returns events with words that contain "konse"
type="event" returns only "events"
start="2017-01-01" events starting on 2017-01-01 or after
end="2017-01-10" events ending on 2017-01-10 or before
For more detailed explanation, see http://api.hel.fi/linkedevents/v1/.
Data frame or a list
Juuso Parkkinen [email protected], Pyry Kantanen
Helsinki Linked Events API v1. Developed by the City of Helsinki Open Software Development team. Event data from Helsinki Marketing, Helsinki Cultural Centres, Helmet metropolitan area public libraries and City of Helsinki registry of service unit. CC BY 4.0. https://creativecommons.org/licenses/by/4.0/
For more API documentation and license information see the API link: http://api.hel.fi/linkedevents/v1/
## Not run: events <- get_linkedevents(query = "search", q = "teatteri", start = "2020-01-01") ## End(Not run)## Not run: events <- get_linkedevents(query = "search", q = "teatteri", start = "2020-01-01") ## End(Not run)
Produces an sf object for Rakennustietoruudukko (building information grid).
get_rakennustietoruudukko(year = NULL)get_rakennustietoruudukko(year = NULL)
year |
year as numeric between 1997-1998 and 2009-2021. If NULL (default), the function will return the latest available dataset. |
Additional data not available here can be manually downloaded from HRI website: https://hri.fi/data/fi/dataset/rakennustietoruudukko
Years 2015-2021 are tested to work at the time of development. Additional years may be added in the future and older datasets may be removed from the API. Datasets from years 2015-2021 are downloaded from HSY WFS API and datasets for other years are downloaded as zip files from HRI website. The format of the output might be a bit different between datasets downloaded from the WFS API and datasets downloaded from HRI website.
Additional years may be added in the future and older datasets may be removed from the API. See package NEWS for more information.
The current datasets can be listed with get_feature_list()
or select_feature().
sf object
Pyry Kantanen [email protected]
## Not run: building_grid <- get_rakennustietoruudukko(year = 2021) ## End(Not run)## Not run: building_grid <- get_rakennustietoruudukko(year = 2021) ## End(Not run)
Access the new Helsinki region Service Map (Paakaupunkiseudun Palvelukartta, https://palvelukartta.hel.fi/fi/) data through the API: http://api.hel.fi/servicemap/v2/. For more API documentation and license information see the API link.
get_servicemap(query, ...)get_servicemap(query, ...)
query |
The API query as a string, for example search, service, or unit. For full list of available options and details, see https://dev.hel.fi/apis/service-map-backend-api/. |
... |
Additional parameters to the API (optional). For additional details, see https://dev.hel.fi/apis/service-map-backend-api/. |
Complete list of possible query input:
"unit" unit, or service point
"service" category of service provided by a unit
"organization" organization providing services
"search" full text search for units, services and street addresses
"accessibility" rule database for calculating accessibility scores
"geography" spatial information, where services are located
With "..." the user can pass on additional parameters that depend on the chosen query input. For example, when performing a search (query = "search"), the search can be narrowed down with parameters such as:
"q" complete search
"input" partial search
"type" valid types: service_node, service, unit, address
"language" as two-character ISO-639-1 code: fi, sv, en
"municipality" comma-separated list of municipalities, lower-case, in Finnish
"service" comma-separated list of service IDs
"include" include the complete content from certain fields with a comma-separated list of field names with a valid type prefix
"only" restricts the results with a comma-separated list of field names with a valid type prefix
"page" request a certain page number
"page_size" determine number of entries in one page
For more detailed explanation, see https://dev.hel.fi/apis/service-map-backend-api/.
Data frame or a list
Juuso Parkkinen [email protected], Pyry Kantanen
API contents: All content is available under CC BY 4.0, except where otherwise stated. The City of Helsinki logo is a registered trademark. The Helsinki Grotesk Typeface is a proprietary typeface licensed by Camelot Typefaces. https://creativecommons.org/licenses/by/4.0/
API Location: https://api.hel.fi/servicemap/v2/
API documentation: https://dev.hel.fi/apis/service-map-backend-api/
## Not run: # A data.frame with 47 variables search_puisto <- get_servicemap(query = "search", q = "puisto") # A data.frame with 7 variables search_padel <- get_servicemap( query = "search", input = "padel", only = "unit.name, unit.location.coordinates, unit.street_address", municipality = "helsinki" ) ## End(Not run)## Not run: # A data.frame with 47 variables search_puisto <- get_servicemap(query = "search", q = "puisto") # A data.frame with 7 variables search_padel <- get_servicemap( query = "search", input = "padel", only = "unit.name, unit.location.coordinates, unit.street_address", municipality = "helsinki" ) ## End(Not run)
Produces an sf object for Väestötietoruudukko (population grid).
get_vaestotietoruudukko(year = NULL)get_vaestotietoruudukko(year = NULL)
year |
a single year as numeric between 1997-2003 and 2008:2021. If NULL (default), the function will return the latest available dataset. |
Additional data not available here can be manually downloaded from HRI website: https://hri.fi/data/fi/dataset/vaestotietoruudukko
Years 1997-2003 and 2008-2021 are tested to work at the time of development. Datasets from years 2015-2021 are downloaded from HSY WFS API and datasets for other years are downloaded as zip files from HRI website. The format of the output might be a bit different between datasets downloaded from the WFS API and datasets downloaded from HRI website.
Additional years may be added in the future and older datasets may be removed from the API. See package NEWS for more information.
The current datasets can be listed with get_feature_list()
or select_feature().
sf object
Pyry Kantanen [email protected]
## Not run: pop_grid <- get_vaestotietoruudukko(year = 2021) ## End(Not run)## Not run: pop_grid <- get_vaestotietoruudukko(year = 2021) ## End(Not run)
Use an interactive menu to select and download a feature for use in other functions
select_feature(base.url = NULL, get = FALSE)select_feature(base.url = NULL, get = FALSE)
base.url |
WFS url, for example "https://kartta.hsy.fi/geoserver/wfs" |
get |
Should the selected feature be downloaded? Default is |
feature Title (character) or feature object (sf), if get parameter is TRUE
Pyry Kantanen [email protected]
## Not run: selection <- select_feature(base.url = "https://kartta.hsy.fi/geoserver/wfs") feature <- get_feature(base.url = "https://kartta.hsy.fi/geoserver/wfs", type_name = selected) ggplot(feature) + geom_sf() ## End(Not run)## Not run: selection <- select_feature(base.url = "https://kartta.hsy.fi/geoserver/wfs") feature <- get_feature(base.url = "https://kartta.hsy.fi/geoserver/wfs", type_name = selected) ggplot(feature) + geom_sf() ## End(Not run)
Transform a wfs_api object into a sf object.
to_sf(api_obj)to_sf(api_obj)
api_obj |
wfs api object |
FMI API response object's XML (GML) content is temporarily wrtitten on disk and then immediately read back in into a sf object.
sf object
For internal use, not exported.
Joona Lehtomäki [email protected]
Requests to various WFS API.
wfs_api(base.url = NULL, queries, ...)wfs_api(base.url = NULL, queries, ...)
base.url |
WFS url, for example "https://kartta.hsy.fi/geoserver/wfs" |
queries |
List of query parameters |
... |
For passing parameters to embedded functions, for example timeout.s (timeout in seconds) in the case of gracefully_fail() internal function |
Make a request to the spesific WFS API. The base url is https://kartta.hsy.fi/geoserver/wfs to which other components defined by the arguments are appended.
This is a low-level function intended to be used by other higher level functions in the package.
wfs_api (S3) object with the following attributes:
XML payload.
path provided to get the resonse.
the original response object.
Joona Lehtomäki [email protected], Kostas Vasilopoulos, Pyry Kantanen
Gracefully failing HTTP request code (slightly adapted by Pyry Kantanen) from RStudio community member kvasilopoulos. Many thanks!
Source of the original RStudio community discussion: https://community.rstudio.com/t/internet-resources-should-fail-gracefully/49199
## Not run: wfs_api( base.url = "https://kartta.hsy.fi/geoserver/wfs", queries = c( "service" = "WFS", "version" = "1.0.0", "request" = "getFeature", "typeName" = "ilmanlaatu:Ilmanlaatu_nyt" ) ) ## End(Not run)## Not run: wfs_api( base.url = "https://kartta.hsy.fi/geoserver/wfs", queries = c( "service" = "WFS", "version" = "1.0.0", "request" = "getFeature", "typeName" = "ilmanlaatu:Ilmanlaatu_nyt" ) ) ## End(Not run)