Core Utilities for the 'rtemis' Ecosystem


[Up] [Top]

Documentation for package ‘rtemis.core’ version 0.4.6

Help Pages

A B C D E F G H I L M N O P R S T U W

rtemis.core-package 'rtemis.core': Rtemis Utilities

-- A --

abbreviate_class Abbreviate object class name
abort Dual-channel error signal
ansi256_to_hex Convert ANSI 256 color code to HEX
assert_config_contract Assert a generated config schema honors the input-schema contract
assert_description_language Assert a published schema's descriptions are language-independent

-- B --

bold Make text bold

-- C --

character_scalar Non-empty character scalar S7 property
checkmark Checkmark
check_bounded_double_scalar Check double scalar within bounds
check_bounded_integer_scalar Check integer scalar within bounds
check_character Check character
check_character_scalar Check character scalar
check_data.table Check data.table
check_dependencies 'rtemis.core' internal: Dependencies check
check_double_scalar Check double scalar
check_enum Check if value is in set of allowed values
check_file_exists Check file exists
check_float01exc Check float between 0 and 1, exclusive
check_float01inc Check float between 0 and 1, inclusive
check_float0pos Check float greater than or equal to 0
check_floatpos Check positive float
check_floatpos1 Check float in (0, 1]
check_float_neg1_1 Check float -1 <= x <= 1
check_inherits Check class of object
check_integer_scalar Check integer scalar
check_logical Check logical
check_logical_scalar Check logical scalar
check_nonneg_double_scalar Check non-negative double scalar
check_nonneg_double_vector Check non-negative double vector
check_numeric Check numeric
check_optional_bounded_double_scalar Check optional double scalar within bounds
check_optional_bounded_integer_scalar Check optional integer scalar within bounds
check_optional_character_scalar Check optional character scalar
check_optional_double_scalar Check optional double scalar
check_optional_integer_scalar Check optional integer scalar
check_optional_logical_scalar Check optional logical scalar
check_optional_nonneg_double_scalar Check optional non-negative double scalar
check_optional_nonneg_double_vector Check optional non-negative double vector
check_optional_pos_double_scalar Check optional positive double scalar
check_optional_pos_double_vector Check optional positive double vector
check_optional_pos_integer_scalar Check optional positive integer scalar
check_optional_prob_scalar Check optional probability scalar
check_optional_prob_vector Check optional probability vector
check_optional_scalar_character Check Optional Scalar Character
check_optional_unit_open_vector Check optional open-unit-interval vector
check_pos_double_scalar Check positive double scalar
check_pos_double_vector Check positive double vector
check_pos_integer_scalar Check positive integer scalar
check_prob_scalar Check probability scalar
check_prob_vector Check probability vector
check_scalar_character Check Scalar Character
check_scalar_logical Check Scalar Logical
check_tabular Check object is tabular
check_unit_open_scalar Check open-unit-interval scalar
check_unit_open_vector Check open-unit-interval vector
clean_colnames Clean column names
clean_int Clean integer input
clean_names Clean names
clean_posint Check positive integer
col256 Apply 256-color formatting
collapse_head Collapse head of vector with commas followed by ellipsis
crossmark Cross mark

-- D --

dbg Debug log message
ddSci Format Numbers for Printing
double_scalar Double scalar S7 property

-- E --

enum Create an enum S7 property

-- F --

fmt Text formatting
fmt_gradient Gradient text
format_trace Pretty-print a captured call trace

-- G --

get_msg_sink Get the current rtemis message sink
get_output_type Get output type
get_verbosity Resolve the current logging verbosity

-- H --

highlight Highlight text
html_div Build a 'div' element
html_escape Escape text for inclusion in HTML
html_li Build a 'li' element
html_p Build a 'p' element
html_raw Mark a string as HTML
html_span Build a 'span' element
html_strong Build a 'strong' element
html_tag Build an HTML element
html_ul Build a 'ul' element

-- I --

info Informational log message
integer_scalar Integer scalar S7 property

-- L --

labelify Format text for label printing
logical_scalar Logical scalar S7 property

-- M --

match_arg Match Arguments Ignoring Case
msg Message with provenance
msg0 Message with provenance
msgdone msgdone
msgstart msgstart

-- N --

nonneg_double_scalar Non-negative double scalar S7 property
nonneg_double_vector Non-negative double vector S7 property
nonneg_integer_scalar Non-negative integer scalar S7 property

-- O --

optional Create an optional S7 type
optional_character_scalar Optional non-empty character scalar S7 property
optional_double_scalar Optional double scalar S7 property
optional_integer_scalar Optional integer scalar S7 property
optional_logical_scalar Optional logical scalar S7 property
optional_nonneg_double_scalar Optional non-negative double scalar S7 property
optional_nonneg_double_vector Optional non-negative double vector S7 property
optional_nonneg_integer_scalar Optional non-negative integer scalar S7 property
optional_pos_double_scalar Optional positive double scalar S7 property
optional_pos_double_vector Optional positive double vector S7 property
optional_pos_integer_scalar Optional positive integer scalar S7 property
optional_prob_scalar Optional probability scalar S7 property
optional_prob_vector Optional probability vector S7 property
optional_unit_open_scalar Optional open-unit-interval scalar S7 property
optional_unit_open_vector Optional open-unit-interval vector S7 property

-- P --

plain Force plain text when using 'message()'
pos_double_scalar Positive double scalar S7 property
pos_double_vector Positive double vector S7 property
pos_integer_scalar Positive integer scalar S7 property
printdf Print data frame
printls Pretty print list
prob_scalar Probability scalar S7 property
prob_vector Probability vector S7 property
progress_begin Begin a progress node
progress_clear Clear the visible progress status line
progress_end End a progress node
progress_lapply 'lapply' with progress
progress_update Update a progress node
prop_bag Opaque named list S7 property
prop_boolean Logical (boolean) S7 property
prop_const Constant S7 property
prop_float Numeric (floating-point) S7 property
prop_integer Integer S7 property
prop_spec A factory-built property's spec
prop_string Character (string) S7 property

-- R --

repr String representation
repr_ls Show list as formatted string
rtemis.core 'rtemis.core': Rtemis Utilities
rtemis_colors rtemis Colors

-- S --

set_msg_sink Set the rtemis message sink
strip_ansi Strip ANSI escape sequences from a string
success Success log message

-- T --

test_inherits Check class of object

-- U --

unit_open_scalar Open-unit-interval scalar S7 property
unit_open_vector Open-unit-interval vector S7 property

-- W --

warn Warning log message
with_msg_sink Run code with a temporary message sink
write_JSONSchema Write a JSON Schema to file
write_lines Write lines to file