Skip to contents

Generate nine PLIDA datasets

Source: R/generate_dil_lightweight.R
generate_dil_lightweight.Rd

These functions generate the APSED, ATO_MCS, ERS, JK, JM, NHS, NSMHW, PEX, and SMSF datasets.

Usage

generate_apsed(
  spine = NULL,
  seed = 42L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = TRUE
)

generate_ato_mcs(
  spine = NULL,
  seed = 42L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = TRUE
)

generate_ers(
  spine = NULL,
  seed = 42L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = TRUE
)

generate_jk(
  spine = NULL,
  seed = 42L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = TRUE
)

generate_jm(
  spine = NULL,
  seed = 42L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = TRUE
)

generate_nhs(
  spine = NULL,
  seed = 42L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = TRUE
)

generate_nsmhw(
  spine = NULL,
  seed = 42L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = TRUE
)

generate_pex(
  spine = NULL,
  seed = 42L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = TRUE
)

generate_smsf(
  spine = NULL,
  seed = 42L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = TRUE
)

Arguments

spine

Data.frame from generate_spine() or NULL. If NULL, the spine is loaded from the active run directory.

seed

Integer. Random seed.

output_dir

Character or NULL. Base output directory. If NULL, uses get_data_path().

format

Character. Currently parquet only. Passing "csv" is accepted by the argument matcher but rejected at runtime.

return_data

Logical. If TRUE, returns generated data.frames in addition to writing parquet.

Value

If return_data = TRUE, a named list of data.frames keyed by PLIDA product name. If FALSE, an invisible metadata list with row counts, variable counts, and output paths.

Dataset and variable information

These official websites give information about the datasets: