create_enrichwith_skeleton {enrichwith} | R Documentation |
Create a enrichwith skeleton
Description
Create an enrichwith skeleton file for the structured implementation of methods to compute new components for objects of a specific class
Usage
create_enrichwith_skeleton(class, option, description, component, path,
filename = paste0(class, "_options.R"), attempt_rename = TRUE)
Arguments
class |
the class of the objects to be enriched |
option |
a character vector with components the enrichment options |
description |
a character vector of length
|
component |
a list of as many character vectors as
|
path |
the path where the skeleton file will be created |
filename |
the name of the skeleton file |
attempt_rename |
attempt to rename syntactically incorrect
component names? Default is |
Value
A file with the necessary functions to use
enrichwith
infrastructure. The skeleton consists of the
following functions
One
compute_component.class
function per component name fromunique(unlist(component))
. The function takes as input the object to be enriched and returns as output the component to be added to the object.The
get_enrichment_options.class
function, that takes as input the object to be enriched and an enrichment option, and returns the names of the components that will be appended to the object for this option. This function can also be used to list the available options and print their description.The
enrich.class
function
Examples
## Not run:
# Set the directory where the skeleton is placed
my_path <- "~/Downloads"
# This is the call that created the enrichment skeleton for glms
# that ships with the package
create_enrichwith_skeleton(class = "glm",
option = c("auxiliary functions", "score vector",
"mle of dispersion", "expected information",
"observed information", "first-order bias"),
description = c("various likelihood-based quantities
(gradient of the log-likelihood, expected and observed
information matrix and first term in the expansion of
the bias of the mle) and a simulate method as functions
of the model parameters",
"gradient of the log-likelihood at the mle",
"mle of the dispersion parameter",
"expected information matrix evaluated at the mle",
"observed information matrix evaluated at the mle",
"first term in the expansion of the bias of the mle
at the mle"),
component = list("auxiliary_functions", "score_mle",
"dispersion_mle",
"expected_information_mle",
"observed_information_mle",
"bias_mle"),
path = my_path,
attempt_rename = FALSE)
## End(Not run)