index.html 18 KB
Newer Older
 Pauline Maury Laribière committed Mar 03, 2022 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73  Metadata Auto R • fso.metadata

Introduction

This repository aims to simplify the access to the Swiss Federal Statistical Office metadata. Following the implementation in the interoperability platform and the SIS portal, the APIs are made available here in R. This public library is made available for the internal FSO staff, the federal administration and for external actors.

Installation

You can install the library with

 Pauline Maury Laribière committed Mar 11, 2022 74 75 
install.packages("remotes") remotes::install_gitlab("dscc/fso-metadata-r")
 Pauline Maury Laribière committed Mar 03, 2022 76 77 78 79 80 81 82 83 84 85 86 87 88 

then at the beginning of your R script, you will need to

library("fso.metadata")

Functionnalities

Based on the metadata that you want, you will call certain functions and parameters.

Codelists

1. Export a codelist based on an identifier
 Pauline Maury Laribière committed Mar 11, 2022 89 
codelist <- get_codelist(identifier, environment, language, export_format, version_format, annotations)
 Pauline Maury Laribière committed Mar 03, 2022 90 91 
Parameters:     - identifier ("character"): the codelist's identifier 
Pauline Maury Laribière committed Mar 11, 2022  92      93      94      95      96      97      98      99      100      101      102      103      104                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        - environment ("character", default="PRD" for production)         Available are 'PRD', 'ABN', 'TEST', 'QA' and 'DEV'.     - language ("character", default="all" for all languages, no filtering)         Available are 'all', 'fr', 'de', 'it', 'en'.     - export_format ("character", default="SDMX-ML"): the export's format.          Available are CSV, XLSX, SDMX-ML or SDMX-JSON.     - version_format ("numeric", default=2.1): the export format's version          (2.0 or 2.1 when format is SDMX-ML).     - annotations (bool, default=FALSE): flag to include annotations Returns:     - codelist (data.frame) based on the export format         - a data.frame if export_format was CSV or XLSX         - a json if export_format was SDMX-ML or SDMX-JSON.
 Pauline Maury Laribière committed Mar 03, 2022 105 106 107 108 109 110 111 

Nomenclatures

1. Export one level of a nomenclature
 Pauline Maury Laribière committed Mar 11, 2022 112 
one_level_df <- get_nomenclature_one_level(identifier, environment, level_number, filters, language, annotations)
 Pauline Maury Laribière committed Mar 03, 2022 113 114 
Parameters:     - identifier ("character"): nomenclature's identifier 
Pauline Maury Laribière committed Mar 11, 2022  115      116      117      118      119      120      121      122      123      124                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           - environment ("character", default="PRD" for production)         Available are 'PRD', 'ABN', 'TEST', 'QA' and 'DEV'.     - level_number ("numeric"): level to export     - filter (list): additionnal filters in form of named list     - language ("character", default='fr'): response data's language          Available are 'fr', 'de', 'it', 'en'.     - annotations (bool, default=FALSE): flag to include annotations Returns:     - response (data.frame): dataframe with 3 columns          (Code, Parent and Name in the selected language)
 Pauline Maury Laribière committed Mar 03, 2022 125 126 127 
1. Export multiple levels of a nomenclature (from level_from to level_to)
 Pauline Maury Laribière committed Mar 11, 2022 128 
multiple_levels_df = get_nomenclature_multiple_levels(identifier, environment, level_from, level_to, filters, language, annotations)
 Pauline Maury Laribière committed Mar 03, 2022 129 130 
Parameters:     - identifier ("character"): nomenclature's identifier 
Pauline Maury Laribière committed Mar 11, 2022  131      132      133      134      135      136      137      138      139      140                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           - environment ("character", default="PRD" for production)         Available are 'PRD', 'ABN', 'TEST', 'QA' and 'DEV'.     - level_from ("numeric"): the 1st level to include     - level_to ("numeric"): the last level to include     - filter (list): additionnal filters in form of named list     - language ("character", default='fr'): response data's language          Available are 'fr', 'de', 'it', 'en'.     - annotations (bool, default=FALSE): flag to include annotations Returns:     - multiple_levels_df (data.frame): dataframe columns from level_from to level_to codes
 Pauline Maury Laribière committed Mar 03, 2022 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 

As the APIs continue to be implemented, further functionnalities will be added.

Upcoming function: Data Structures

1. Get the data structure (not available yet)
data_structure <- get_data_structure(identifier, language)
Parameters:     - identifier ("character"): the nomenclature's identifier     - language ("character", default='fr'): the language of the response data.          Available are 'fr', 'de', 'it', 'en'. Returns:     - data_structure: data structure

Background

All the APIs made available in this library are also documented in Swagger UI should you want to do more experiments through a UI.

• Here for APIs of the interoperability platform (public).
• Here for dcat APIs (internal to configuration).

Example

Examples for each API are provided in the R Markdown.

 Pauline Maury Laribière committed Mar 11, 2022 174 175 

Practical demo.

A documentation page is also available here.

 Pauline Maury Laribière committed Mar 03, 2022 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213