| Type: | Package |
| Title: | Search and Get Data from the I14Y Interoperability Platform of Switzerland |
| Version: | 0.1.7 |
| Maintainer: | Felix Luginbuhl <felix.luginbuhl@protonmail.ch> |
| Description: | Search and download Swiss data and metadata from the I14Y interoperability platform of Switzerland using its public APIs https://www.i14y.admin.ch/api/index.html. |
| License: | GPL (≥ 3) |
| BugReports: | https://github.com/lgnbhl/I14Y/issues |
| URL: | https://felixluginbuhl.com/I14Y/ |
| Depends: | R (≥ 4.0) |
| Imports: | httr2, tibble, readr, cli, curl, rlang (≥ 1.1.0) |
| Suggests: | jsonlite, dplyr, stringr, BFS, testthat (≥ 3.0.0) |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.3.2 |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2025-10-28 09:13:47 UTC; felix |
| Author: | Felix Luginbuhl 
[aut, cre, cph],
Felix Lorenz [ctr] |
| Repository: | CRAN |
| Date/Publication: | 2025-10-28 09:30:02 UTC |
Export a codelist
Description
The function uses the I14Y Console API: <https://apiconsole.i14y.admin.ch/public/v1/index.html>.
Usage
i14y_get_codelist(id = NULL, format = "csv")
Arguments
id |
string. The Id of the response data. |
format |
string. The format of the export ("csv" or "json"). |
Value
a tibble
Examples
i14y_get_codelist(
id = "08d94604-e058-62a2-aa25-53f84b974201" # for DV_NOGA_DIVISION
)
Get Concept view entity by ID
Description
Get Concept view entity by ID
Usage
i14y_get_concept(id = NULL, language = "de")
Arguments
id |
string. The Id of the response data. |
language |
string. The language of the response data. |
Value
a list
Examples
i14y_get_concept(
id = "08d94604-e058-62a2-aa25-53f84b974201", # DV_NOGA_DIVISION
language = "en"
)
Get all versions of an ID
Description
Get all versions of an ID
Usage
i14y_get_concept_all_versions(id = NULL, language = "de")
Arguments
id |
string. The Id of the response data. |
language |
string. The language of the response data. |
Value
a list
Examples
i14y_get_concept_all_versions(
id = "08d94604-e058-62a2-aa25-53f84b974201", # DV_NOGA_DIVISION
language = "de"
)
Get the information of a nomenclature by identifier
Description
Get the information of a nomenclature by identifier
Usage
i14y_get_content_information(identifier = NULL)
Arguments
identifier |
string. The identifier of the nomenclature. |
Value
a list
Examples
i14y_get_content_information(
identifier = "HCL_CH_ISCO_19_PROF"
)
Get the dataStructures
Description
Get the dataStructures
Usage
i14y_get_data_structure(identifier = NULL, language = "de")
Arguments
identifier |
string. The identifier of the dcat dataset. |
language |
string. The language of the response data. |
Value
a list
Examples
df <- i14y_get_data_structure(
identifier = "SpiGes_Erhebung_Administratives"
)
Get dataset full metadata by ID
Description
Get dataset full metadata by ID
Usage
i14y_get_dataset_metadata(id = NULL)
Arguments
id |
string. The id of the dcat dataset. |
Value
a list
Examples
i14y_get_dataset_metadata(id = "02e34f85-14df-45b5-a38b-2f063c999481")
Export a level of a nomenclature
Description
Export a level of a nomenclature
Usage
i14y_get_nomenclature_level(
identifier = NULL,
language = "de",
level = 1,
format = "csv",
annotations = FALSE,
filters = NULL
)
Arguments
identifier |
string. The identifier of dcat dataset. |
language |
string. The language of the response data. |
level |
integer. The level to export. Default 1. |
format |
string. The format of the export (CSV or XLSX). |
annotations |
boolean. Include annotations. Default FALSE. |
filters |
object. The filters |
Value
a tibble
Export multiple levels of a nomenclature
Description
Export multiple levels of a nomenclature
Usage
i14y_get_nomenclature_level_multiple(
identifier = NULL,
language = "de",
levelFrom = NULL,
levelTo = NULL,
format = "csv",
annotations = NULL,
filters = NULL
)
Arguments
identifier |
string. The identifier of dcat dataset. |
language |
string. The language of the response data. Default "de". |
levelFrom |
integer. The first level to include. |
levelTo |
integer. The last level to include. |
format |
string. The format of the export ("csv" or "xlsx"). Default "csv". |
annotations |
boolean. Include annotations |
filters |
object. The filters |
Value
a tibble
Examples
i14y_get_nomenclature_level_multiple(
identifier = "HCL_CH_ISCO_19_PROF",
format = "csv", # read internally
levelFrom = 1,
levelTo = 2,
language = "fr"
)
Search the catalog for datasets, data services and public services.
Description
Search the catalog for datasets, data services and public services.
Usage
i14y_search_catalog(
query = NULL,
language = "de",
accessRights = NULL,
formats = NULL,
publishers = NULL,
statuses = NULL,
themes = NULL,
types = NULL,
page = NULL,
pageSize = NULL
)
Arguments
query |
string. The search query |
language |
string. The language to use for the search |
accessRights |
vector of strings. Only results with one of the specified access rights (PUBLIC, NON_PUBLIC, RESTRICTED) are returned |
formats |
vector of strings. Only results with at least one distribution providing one of the specified formats are returned |
publishers |
vector of strings. Only results with one of the specified publishers are returned |
statuses |
vector of strings. Only results with one of the specified registration statuses are returned |
themes |
vector of strings. Only results corresponding to one of the specified themes are returned |
types |
vector of strings. Only results with one of the specified types (Dataset, DataService, PublicService) are returned |
page |
integer. The number of the result page to return |
pageSize |
integer. The size of each result page |
Value
a tibble
Examples
i14y_search_catalog(query = "noga")
Search for a Concept Summary
Description
Search for a Concept Summary
Usage
i14y_search_concept(
query = NULL,
language = "de",
page = 1,
pageSize = 1000,
publishers = NULL,
themes = NULL,
conceptValueTypes = NULL,
registrationStatuses = NULL
)
Arguments
query |
string. Search query. |
language |
string. The language of the response data. |
page |
integer. The number of the result page to return. |
pageSize |
integer. The size of each result page. |
publishers |
vector of strings. Filter with Publishers identifiers. |
themes |
vector of strings. Filter with theme codes. |
conceptValueTypes |
character vector. One or more concept value types to filter by. |
registrationStatuses |
character vector. One or more registration statuses to filter by. |
Value
a tibble
Examples
i14y_search_concept(query = "noga", language = "en")
Search within a nomenclature
Description
Search within a nomenclature
Usage
i14y_search_nomenclature(
identifier = NULL,
query = NULL,
language = "de",
page = NULL,
pageSize = NULL,
filters = NULL
)
Arguments
identifier |
string. The identifier of dcat dataset. |
query |
string. The search query. |
language |
string. The language of the response data. |
page |
integer. The number of the result page to return |
pageSize |
integer. The size of each result page |
filters |
object. The filters |
Value
a list