Commit f98e0907 authored by Pauline Maury Laribière's avatar Pauline Maury Laribière
Browse files

done

parent a239825b
Pipeline #323963 passed with stage
in 16 seconds
# Metadata Auto R Library
# FSO Metadata Auto R Package
## Introduction
......@@ -15,7 +15,7 @@ devtools::install_github("SDCC/metadata-auto-r-library")
then at the beginning of your R script, you will need to
```
library("metadata-auto-r-library")
library("fso.metadata")
```
......@@ -41,20 +41,6 @@ codelist <- get_codelist(identifier, export_format, version_format, annotations)
- a json if export_format was SDMX-ML or SDMX-JSON.
### Data Structures
1. Get the data structure
```
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
### Nomenclatures
1. Export one level of a nomenclature
......@@ -93,6 +79,21 @@ multiple_levels_df = get_nomenclature_multiple_levels(identifier, level_from, le
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](https://www.i14y.admin.ch/api/index.html) for APIs of the interoperability platform (public).
......@@ -100,4 +101,4 @@ All the APIs made available in this library are also documented in Swagger UI sh
## Example
Examples for each API are provided in the [R Markdown](https://renkulab.io/gitlab/pauline.maury-laribiere/metadata-auto-r-library/-/blob/r_apis/example.Rmd).
Examples for each API are provided in the [R Markdown](https://renkulab.io/gitlab/dscc/metadata-auto-r-library/-/blob/master/example.Rmd).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment