Skip to contents

Print the pedagogical narrative for a morie callable.

Source: R/describe.R
morie_describe.Rd

Loads the describe_.md narrative shipped in the package's inst/extdata/describe_corpus.Rds bundle and prints it to the console. This is the R-side mirror of the Python morie.describe() function (closing the v0.9.5.4 parity gap; shipped in v0.9.5.5).

Usage

morie_describe(callable)

Arguments

callable

A morie callable, as a function object (passed unquoted), or a character scalar name. The lookup strips the leading morie_ prefix automatically.

Value

Invisibly returns the narrative as a character scalar. If no matching describe entry is found, returns NULL and prints a helpful diagnostic.

Details

The lookup is forgiving: a leading morie_ prefix on the callable name is stripped automatically, so morie_describe("aalen") and morie_describe("morie_aalen") resolve to the same narrative.

See also

morie_describe_by_name for the string-only variant that does not capture symbol names.

Examples

if (FALSE) { # \dontrun{
morie_describe("aalen")
morie_describe("morie_aalen")  # leading prefix stripped
morie_describe(morie_aalen)    # function-object form
} # }