Function reference • ready4use

S3 Classes

ready4use_distributions() make_pt_ready4use_distributions() is_ready4use_distributions(): ready4 submodule class for list object that summarises the parameters of each distribution

ready4use_dataverses() make_pt_ready4use_dataverses() is_ready4use_dataverses(): ready4 submodule class for tibble object lookup table of files to be imported from a dataverse.

ready4use_imports() make_pt_ready4use_imports() is_ready4use_imports(): ready4 submodule class for tibble object lookup table of sources of raw (un-processed) data to import.

ready4use_mapes() make_pt_ready4use_mapes() is_ready4use_mapes(): ready4 submodule class for tibble object that stores simulation structural parameters relating to Mean Absolute Prediction Errors.

ready4use_dictionary() make_pt_ready4use_dictionary() is_ready4use_dictionary(): ready4 s3 class defining a data dictionary tibble.

S4 Classes

Ready4useFiles-class Ready4useFiles: Ready4useFiles

Ready4useRaw-class Ready4useRaw: Ready4useRaw

Ready4useProcessed-class Ready4useProcessed: Ready4useProcessed

Ready4useArguments-class Ready4useArguments: Ready4useArguments

Ready4useDyad-class Ready4useDyad: Ready4useDyad

Ready4useIngest-class Ready4useIngest: Ready4useIngest

Ready4useRepos-class Ready4useRepos: Ready4useRepos

Ready4usePointer-class Ready4usePointer: Ready4usePointer

Ready4useRecord-class Ready4useRecord: Ready4useRecord

Functions

add_labels_from_dictionary(): Add labels from dictionary

assert_matches_chr(): Assert matches character vector

assert_single_row_tb(): Assert single row tibble

get_r3_from_dv_csv(): Get ready4 submodule from dataverse comma separated variables file

Methods

exhibit.ready4use_dictionary() exhibit(<ready4use_dictionary>) exhibit(<Ready4useDyad>): Exhibit features of model module data by printing them to the R console

ingest(<Ready4useRepos>): Ingest data

manufacture.ready4use_dataverses() manufacture(<ready4use_dataverses>) manufacture.ready4use_imports() manufacture(<ready4use_imports>) manufacture(<Ready4useDyad>): Manufacture a new object

procure.ready4use_dataverses() procure(<ready4use_dataverses>) procure.ready4use_imports() procure(<ready4use_imports>) procure(<Ready4useIngest>): Procure data from a model module

renew.ready4use_dictionary() renew(<ready4use_dictionary>) renew.ready4use_imports() renew(<ready4use_imports>) renew(<Ready4useDyad>): Renew (update) values

share(<Ready4useRecord>) share(<Ready4useRepos>): Share data via an online repository