Function reference • specific

Datasets

mdl_types_lup: Model types lookup table

plt_types_lup: Model plot types lookup table

rprt_lup: Report types lookup table

S3 Classes

specific_models() make_pt_specific_models() is_specific_models(): Candidate models lookup table

specific_predictors() make_pt_specific_predictors() is_specific_predictors(): Candidate predictors lookup table

S4 Classes

SpecificParameters-class SpecificParameters: SpecificParameters

SpecificPrivate-class SpecificPrivate: SpecificPrivate

SpecificShareable-class SpecificShareable: SpecificShareable

SpecificResults-class SpecificResults: SpecificResults

SpecificProject-class SpecificProject: SpecificProject

SpecificInitiator-class SpecificInitiator: SpecificInitiator

SpecificModels-class SpecificModels: SpecificModels

SpecificPredictors-class SpecificPredictors: SpecificPredictors

SpecificFixed-class SpecificFixed: SpecificFixed

SpecificMixed-class SpecificMixed: SpecificMixed

SpecificConverter-class SpecificConverter: SpecificConverter

SpecificSynopsis-class SpecificSynopsis: SpecificSynopsis

Functions

get_background_text(): Get background text

get_cndts_for_mxd_mdls(): Get candidates for mixed models

get_conclusion_text(): Get conclusion text

get_covar_ctgs(): Get covariate categories

get_covars_by_ctg(): Get covariates by category

get_link_from_tfmn(): Get link from transformation

get_mdl_cmprsns(): Get model comparisons

get_mdl_type_from_nm(): Get model type from name

get_mdls_with_signft_covars(): Get models with significant covariates

get_nbr_of_predrs(): Get number of predictors

get_nbr_of_predrs_by_ctg(): Get number of predictors by category

get_nbr_of_scndry_analyses(): Get number of secondary analyses

get_ordered_sngl_csnl_mdls(): Get ordered single cross-sectional models

get_popl_descvs(): Get population descriptives

get_predr_ctgs(): Get predictor categories

get_predrs_by_ctg(): Get predictors by category

get_prefd_mdl_predrs(): Get preferred model predictors

get_scndry_anlys_descs(): Get secondary analysis descriptions

get_selected_mixed_mdls(): Get selected mixed models

get_signft_covars(): Get significant covariates

make_abstract_args_ls(): Make abstract arguments list

make_analysis_ds_smry_ls(): Make analysis dataset summary list

make_cmpst_sctr_and_dnst_plt(): Make composite scatter and density plot

make_cndt_predr_text(): Make candidate predictor text

make_coi_text(): Make conflict of interest text

make_correlation_text(): Make correlation text

make_covariates_text(): Make covariates text

make_data_availability_text(): Make data availability text

make_dnst_and_sctr_plt_title(): Make density and scatter plot title

make_ds_descvs_ls(): Make dataset descriptives list

make_ds_smry_ls(): Make dataset summary list

make_ethics_text(): Make ethics text

make_fake_ts_data(): Make fake time series data

make_funding_text(): Make funding text

make_indpnt_predrs_lngl_tbl_title(): Make independent predictors longitudinal table title

make_indpnt_predrs_lngl_tbls_ref(): Make independent predictors longitudinal tables reference

make_input_params(): Make input parameters

make_knit_pars_ls(): Make knit pars list

make_maui_params_ls(): Make multi-attribute utility instrument parameters list

make_mdl(): Make model

make_mdl_coef_range_text(): Make model coefficient range text

make_mdl_desc_lines(): Make model description lines

make_nbr_at_fup_text(): Make number at follow-up text

make_nbr_included_text(): Make number included text

make_predr_vals(): Make predictor values

make_predr_vars_nms_ls(): Make predictor variables names list

make_predrs_for_best_mdls(): Make predictors for best models

make_prefd_mdls_vec(): Make preferred models vector

make_random_forest_text(): Make random forest text

make_results_ls(): Make results list

make_scaling_text(): Make scaling text

make_scndry_anlys_params(): Make secondary analysis parameters

make_scndry_anlys_text(): Make secondary analysis text

make_selected_mdl_text(): Make selected model text

make_shareable_mdl(): Make shareable model

make_study_descs_ls(): Make study descriptions list

make_ten_fold_text(): Make ten fold text

make_ten_folds_tbl_title(): Make ten folds table title

make_tfmn_cmprsn_plt(): Make transformation comparison plot

make_within_between_ratios_text(): Make within between ratios text

predict_vals(): Predict values

print_all_plts_for_mdl_set(): Print all plots for model set

print_cohort_table(): Print cohort table

print_cors_tbl(): Print correlations table

print_covar_ttu_tbls(): Print covariate transfer to utility algorithm tables

print_indpnt_predrs_coefs_tbl(): Print independent predictors coefficients table

print_indpnt_predrs_lngl_mdl_coefs(): Print independent predictors longitudinal model coefficients

print_ten_folds_tbl(): Print ten folds table

print_ts_mdl_plts(): Print time series model plots

reorder_cndt_predrs_chr(): Reorder candidate predictors character vector

transform_data_tb_for_cmprsn(): Transform data tibble for comparison

transform_ds_for_mdlng(): Transform dataset for modelling

transform_ds_to_predn_ds(): Transform dataset to prediction dataset

transform_mdl_vars_with_clss(): Transform model variables with classes

transform_tb_to_mdl_inp(): Transform tibble to model input

write_analyses(): Write analyses

write_mdl_cmprsn(): Write model comparison

write_mdl_type_covars_mdls(): Write model type covariates models

write_mdl_type_multi_outps(): Write model type multi outputs

write_mdls_with_covars_cmprsn(): Write models with covariates comparison

write_predr_and_covars_cmprsn(): Write predictor and covariates comparison

write_predr_cmprsn_outps(): Write predictor comparison outputs

write_shareable_mdls(): Write shareable models

write_sngl_predr_multi_mdls_outps(): Write single predictor multi models outputs

write_to_delete_ds_copies(): Write to delete dataset copies

write_to_delete_mdl_fls(): Write to delete model files

write_ts_mdls_from_alg_outp(): Write time series models from algorithm output

Methods

author(<SpecificModels>) author(<SpecificSynopsis>) author(<SpecificProject>): Author and save files

authorData(<SpecificMixed>): Author and document datasets

depict(<SpecificSynopsis>) depict(<SpecificProject>): Depict (plot) features of a dataset

enhance(<SpecificSynopsis>): Enhance a dataset by adding new elements

exhibit.specific_models() exhibit(<specific_models>) exhibit.specific_predictors() exhibit(<specific_predictors>) exhibit(<SpecificProject>): Exhibit features of a dataset by printing them to the R console

investigate(<SpecificModels>) investigate(<SpecificMixed>) investigate(<SpecificPredictors>) investigate(<SpecificFixed>): Investigate solutions to an inverse problem

manufacture(<SpecificResults>) manufacture(<SpecificProject>) manufacture(<SpecificSynopsis>): Manufacture a new object

metamorphose(<SpecificMixed>) metamorphose(<SpecificConverter>): Metamorphose data from one model module (or sub-module) instance to an instance of a different model module or sub-module

procure(<SpecificProject>): Procure items from a dataset

ratify(<SpecificModels>): Ratify that a dataset meets validity criteria

renew.specific_models() renew(<specific_models>) renew.specific_predictors() renew(<specific_predictors>) renew(<SpecificProject>) renew(<SpecificMixed>): Renew values in a dataset

share(<SpecificProject>) share(<SpecificSynopsis>): Share data via an online repository