read_me {SIAmodules}

How to use this package

Description

Prints information on how to use the modules included in the package. You may have already seen the same information when loading the package.

Usage

read_me()

Details

The printed message also displays hyperlinks to each module's help page, where you can find more detailed information, including the citation entry.

Note that if your console does not support hyperlinks, modules titles will be accompanied by a regular R code you may paste into your console to arrive at the same help page.

Value

An object of class siamod_readme. Called for side effects.

Examples

read_me()