Getting help on an app

The app_help() function is a top-level import. It provides you with detailed help on an individual app. You pass the name of the app you want information on (see available apps) as a string. Below, I request help for the app omit_degenerates by passing that name as a string.

The resulting vignette has multiple of sections.

1. “Overview” describes the app purpose.

2. “Options for making the app” shows how to create an app instance using get_app() (Getting an app). It includes the positional and keyword arguments for the app.

3. “Parameters” lists the documentation describing the arguments.

4. “Input type” states what data types are acceptable as input to the app.

5. “Output type” states what data type will be generated by the app.