The studio guide for mascot_character().
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_character")
It opens on this function's guide; change a control and watch the mascot.
Choose a character for the job
A character helper packages a choice for the character
argument. Use an id from the listing below, either on its own or inside
the helper. These two calls choose the same character:
mascot::mascot("helper", character = "tessa")
mascot::mascot("helper", character = mascot::mascot_character("tessa"))
Shipped characters
Use the id column when writing a call. The listing also
identifies the family and whether a character is stable or
experimental.
| id | name | description | family | is_default | built_in | lifecycle | palettes |
|---|---|---|---|---|---|---|---|
| tessa | Tessa | A calm teal hexagonal maker with a silver ring, a bow and a chest badge that shows her mood. | hexonians | TRUE | TRUE | stable | night_teal, sea_green, forest, spring, peach, coral_navy, desert_coral, rose_soft, lilac_soft, mist_navy |
| sela | Sela | A reassuring lilac Hexonian with time blocks; suits scheduling and resource planning. | hexonians | FALSE | TRUE | stable | lilac_violet, orchid, coral_navy, azure, peach_ink, lilac_soft, mist_navy, desert_clay, forest, apricot_navy, blush_plum, lilac_dusk, sea_green |
| knurl | Knurl | A single-wheeled repair bot with a clamp arm and screen visor; suits job queues and diagnostics. | visorfolk | FALSE | TRUE | experimental | original, orbit, carbon, cobalt_droid, crimson |
| neer | Neer | A blue wave crest with a scallop clip. | elementals | FALSE | TRUE | experimental | original, lagoon, glacier, coral_reef, night_bay, monsoon |
What comes with the character
- Moods:
mascot_moods()lists the faces and their status text. - Gestures:
mascot_gestures()lists the movements you can request. - Anchors:
mascot_anchors()lists attachment points on the drawing. - Palettes:
mascot_palettes()lists the named colour choices.
Check these listings for the character you choose before reusing code written for another character.
Warnings, errors and common mistakes
mascot_character("unknown-character")