sm_irr_internal: 'sm_irr' module (internal documentation)

In SIAmodules: Modules for 'ShinyItemAnalysis'

sm_irr module (internal documentation)

Description

This is the internal documentation of your module that is not included in the help index of the package. You may include your notes here. For user-facing help page, please edit the entry in the YAML.

Usage

sm_irr_server(id, imports = NULL, ...)

sm_irr_ui(id, imports = NULL, ...)

Arguments

id	character, the ID assigned by ShinyItemAnalysis.
imports	list, objects exported for the module by ShinyItemAnalysis.
...	Additional parameters (not used at the moment).

Details

Even being internal, a user can still discover this help page. To prevent that, include the ⁠@noRd⁠ roxygen2 tag below (in the source .R file).

If your module uses any external packages, such as ggplot2, you have to declare the imports with the ⁠@importFrom⁠ tag and include the package in the DESCRIPTION. See https://r-pkgs.org/dependencies-in-practice.html for more details.

SIAmodules documentation built on April 4, 2025, 2:39 a.m.