FODRDataset: main dataset class

In Tutuchan/fodr: Interact with French open data services

Description

This is the entry point to retrieve records from a dataset. Initialize a FODRDataset with a portal and an id using the fodr_dataset wrapper.

Format

An object of class R6ClassGenerator of length 24.

Value

An object of class FODRDataset with methods designed to retrieve data from an open dataset.

Fields

portal

a character, must be one of the available portals

data

a data.frame returned by the get_records method

fields

a character vector

facets

a character vector or variables that can be used to filter results

id

a character, the dataset id

info

a list of five elements:

• features: a character vector of available services on this dataset, unused

• metas: a list of meta-information about the dataset (publisher, language, theme, etc.)

• attachments: a list of downloadable files related to this dataset, if any, not downloadable from R

• alternative_exports: unknown purpose

• billing_plans: unknown purpose

sortables

a character vector containing a subset of fields, indicates on which fields sorting is allowed

url

a character, the actual url sent to the API

Methods

get_attachments

This method retrieves attachments from the dataset.

get_records

This method retrieves records from the dataset.

Tutuchan/fodr documentation built on May 9, 2019, 5:16 p.m.