czso_get_dataset_doc {czso}

Get documentation for CZSO dataset

Description

Retrieves the URL/downloads the file containing the documentation of the dataset, in the required format.

Usage

czso_get_dataset_doc(
  dataset_id,
  action = c("return", "open", "download"),
  destfile = NULL,
  format = c("html", "pdf", "word")
)

Arguments

dataset_id

Dataset ID

action

Whether to return URL (the default), download the file, or open the URL in the default web browser.

destfile

Where to save the file. Only used if if action = download.

format

What file format to access: html (the default), pdf, or word.

Details

The document to which this functions provides access contains methodological background on the specified dataset and is identified by the schema field in the list returned by czso_get_dataset_metadata().

Value

if action = download, the path to the downloaded file; file URL otherwise.

See Also

Other Additional tools: czso_get_dataset_metadata(), czso_get_table_schema(), get_czso_dataset_doc(), get_czso_dataset_metadata(), get_czso_table_schema()

Examples

czso_get_dataset_doc("110080")