The mascot studio (mascot_studio()) explains every
function on a page of its own: what it does, what to try, and the common
mistakes. The same pages are here, grouped the way the studio groups
them.
Character and mood
Who is drawn and how they feel. A mood changes the face, the pose and the default status text.
-
mascot_read_character(): Read a local character file -
mascot_check_character(): Check a character description -
mascot_character(): Choose a mascot character -
mascot_mood(): Choose a mascot mood -
mascot_moods(): List mascot moods -
mascot_characters(): List the characters you can use -
mascot_families(): List the character families -
mascot_anchors(): List a character’s anchors
Messages and clicks
Words and actions on the mascot: a status line that is always there, a speech bubble for news, and what a click does (one action or a menu).
-
mascot_status(): Set a mascot’s status text -
mascot_bubble(): Set a mascot’s message bubble -
mascot_action(): Make the mascot a button for one action -
mascot_popup_menu(): Choose a mascot’s click menu
Motion and gestures
Whether changes animate, and one-off movements that leave the mood as it is.
-
mascot_motion_settings(): Choose which parts of the mascot move -
mascot_gesture(): Choose a one-off mascot gesture -
mascot_gestures(): List the mascot gestures
Size and placement
How big the mascot is, on wide and narrow screens, and whether it sits in the page or floats.
-
mascot_size(): Set the mascot’s size -
mascot_placement(): Place a mascot in a floating corner or inline
Colours and theme
Recolour any part of the character, follow your app’s brand, and choose light or dark.
-
mascot_colour_roles(): List a character’s colour roles -
mascot_palettes(): List a character’s colour palettes -
mascot_theme(): Set a mascot’s colours and light or dark mode
Wiring it in Shiny
Where each call goes: mascot() in the UI, update_mascot() in the server, and modules.
-
mascot(): Add a mascot to a page -
update_mascot(): Update a mascot in a Shiny app
Preview page
An offline page that compares moods, colours and sizes without running Shiny. While it is selected, its page replaces the live mascot on the canvas.
-
mascot_preview(): Preview a mascot in light and dark mode
Bundled examples
Small apps that each teach one scenario. Copy one to start your own.
-
mascot_examples(): List the bundled example apps -
mascot_example(): Run or locate a bundled example app -
mascot_studio(): Launch the interactive mascot studio