get_modules: Get the SIA Modules Manifest for the currently developed...

View source: R/get_modules.R

get_modulesR Documentation

Get the SIA Modules Manifest for the currently developed package

Description

Returns a list with all modules for the current package as described in its SIA Modules Manifest, which resides at ⁠/inst/sia/modules.yml⁠ and is generated with add_module() calls. Can be formatted as a tibble using the respective print method.

Usage

get_modules(proj = curr_proj())

Arguments

proj

character, a path to the project. Defaults to current project.

Value

A SIA Modules Manifest of class sm_manifest. Inherits from a list.

See Also

Other module management functions: add_module(), preview_module(), remove_module()

Examples

## Not run: 
get_modules()

## End(Not run)


SIAtools documentation built on April 4, 2025, 2:13 a.m.