Function reference • ready4

S4 Classes

Ready4Module-class Ready4Module: Ready4Module

Ready4Private-class Ready4Private: Ready4Private

Ready4Public-class Ready4Public: Ready4Public

Functions

get_from_lup_obj(): Get a value from a lookup table

get_libraries_tb(): Get a table of ready4 libraries

get_methods(): Get the methods associated with a ready4 model module

get_methods_tb(): Get a table of methods associated with ready4 model modules

get_modules_tb(): Get a table of ready4 model modules

make_code_releases_tbl(): Make a tabular summary of release history of ready4 code libraries and executables

make_datasets_tb(): Make a tabular summary of ready4 model data collections

make_ds_releases_tbl(): Make a tabular summary of release history of ready4 model data collections

make_methods_tb(): Make a tabular summary of methods associated with ready model modules

make_modules_tb(): Make a tabular summary of ready4 model modules and sub-modules

make_programs_tbl(): Make a tabular summary of programs using ready4 model modules

print_data(): Print a table of ready4 model data collections

print_methods(): Print a table of methods associated with ready4 model modules

print_modules(): Print a table of ready4 model modules

print_packages(): Print a table of ready4 libraries

write_to_copy_rmds(): Write a local copy of RMD or Rmarkdown files

write_to_render_post(): Write ready4 model documentation website page from an RMD or Rmarkdown file

write_ws(): Write ready4 software develoment local directories

Generics

author(): Author and save files

authorClasses(): Author and document classes

authorData(): Author and document datasets

authorFunctions(): Author and document functions

authorReport(): Author and save a report

authorSlot(): Apply the author method to a model module slot

characterize(): Characterize model module data by generating (tabular) descriptive statistics

characterizeSlot(): Apply the characterize method to a model module slot

depict(): Depict (plot) features of model module data

depictSlot(): Apply the depict method to a model module slot

enhance(): Enhance a model module by adding new elements

enhanceSlot(): Apply the enhance method to a model module slot

exhibit(): Exhibit features of model module data by printing them to the R console

exhibitSlot(): Apply the exhibit method to a model module slot

ingest(): Ingest data

ingestSlot(): Apply the ingest method to a model module slot

investigate(): Investigate solutions to an inverse problem

investigateSlot(): Apply the investigate method to a model module slot

manufacture(): Manufacture a new object

manufactureSlot(): Apply the manufacture method to a model module slot

metamorphose(): Metamorphose a model module to a model module of a different (non-inheriting) class

metamorphoseSlot(): Apply the metamorphose method to a model module slot

procure(): Procure data from a model module

procureSlot(): Procure (get) data from a slot

prognosticate(): Prognosticate (make predictions) by solving a forward problem

prognosticateSlot(): Apply the prognosticate method to a model module slot

ratify(): Ratify that input or output data meet validity criteria

ratifySlot(): Apply the ratify method to a model module slot

reckon(): Reckon (calculate) a value

reckonSlot(): Apply the reckon method to a model module slot

renew(): Renew (update) values

renewSlot(): Apply the renew method to a model module slot

share(): Share data via an online repository

shareSlot(): Apply the share method to a model module slot

Methods

authorSlot(): Apply the author method to a model module slot

characterizeSlot(): Apply the characterize method to a model module slot

depictSlot(): Apply the depict method to a model module slot

enhanceSlot(): Apply the enhance method to a model module slot

exhibitSlot(): Apply the exhibit method to a model module slot

ingestSlot(): Apply the ingest method to a model module slot

investigateSlot(): Apply the investigate method to a model module slot

manufactureSlot(): Apply the manufacture method to a model module slot

metamorphoseSlot(): Apply the metamorphose method to a model module slot

procureSlot(): Procure (get) data from a slot

prognosticateSlot(): Apply the prognosticate method to a model module slot

ratifySlot(): Apply the ratify method to a model module slot

reckonSlot(): Apply the reckon method to a model module slot

renewSlot(): Apply the renew method to a model module slot

shareSlot(): Apply the share method to a model module slot