The studio guide for mascot_examples().
The same page is read in the mascot studio.
Try it live.
The mascot studio shows this function with live controls and the generated code. In an R session with the optional packages bslib and knitr installed, run:
mascot::mascot_studio(fn = "mascot_examples")
It opens on this function's guide; change a control and watch the mascot.
Pick an example by its task
The descriptions below show what each example teaches. Use the
name column as the value to pass when opening one with
mascot_example() .
| name | title | description |
|---|---|---|
| studio | Mascot studio | Every function and argument, live, with explanations and the code to copy. |
| form-check | Check a form | A worried helper names invalid fields and becomes happy when both pass. |
| long-task | Show task progress | Thinking during a slow step, then success or a lasting error bubble. Requires promises and later. |
| modules | Work in modules | Two module helpers and a parent-owned floating helper. |
| theme | Theme a mascot | A palette, your own or your brand's colours, the code to copy and every mood checked. Requires bslib. |
| golem | Work in golem | Function-built UI, golem runtime options and two nested review modules. Requires golem. |
| rhino | Use a rhino-shaped structure | Plain Shiny view modules with two nested reviews; no rhino or box needed. |
List the names
mascot::mascot_examples()The listing is a plain data frame, in the order the examples are best read. Start with the first entry, then take the scenario that matches your app.
Warnings, errors and common mistakes
This listing takes no arguments. Use its returned names rather than typing guesses.