R6 Modules

List of R6 Classes provided by tidymodules

ModStore

R6 Class Representing a ModStore

Store

This TidyModule is used to explore the content of the ModStore.

TidyModule

TidyModule R6 Class, parent of all modules

Utility functions

List of utility functions

showExamples()

Launcher for the tidymodules examples

getSessionId()

Function that generates session Id

callModules()

Call modules function

add_module()

Create a module

add_tm_snippets()

Add {tm} snippets to RStudio

check_and_load()

check if package namespace exist, load it or display relevant information

getMod()

Retrieve module from ModStore

mod()

Alias to getMod

port()

Retrieve module's port

oport()

Retrieve output module's port

iport()

Retrieve input module's port

Configuration

List of available configurations

global_options

tidymodules options

session_type

List of possible session types

getCacheOption()

Retrieve cache option from the environment

Port functions and operators

List of functions and pipe operators used to manage modules communication

defineEdges()

Function wrapper for ports connection expression.

map_ports()

Ports mapping function

combine_ports()

Combine ports function

race_ports()

Race ports function

%>y%

Input port mapping function

%>>y%

Input port mapping function

`%->%`

Port mapping function (port level)

`%->>%`

Port mapping function (port level) - forward version

%x>y%

Single-port mapping function

%x>>y%

Single-port mapping function

%x

Single-port mapping function (Reverse version)

%x<

Single-port mapping function (Reverse version)

`%:>:%`

Multi-port mapping function

`%:>>:%`

Multi-port mapping function

`%:i:%`

Multi-port mapping function