1.6. Documentation of the +rise package

The +rise package groups RISE’s housekeeping commands. Each is documented below from its own help text.

1.6.1. Opening the PDF documentation

doc: Opens the RISE documentation

Syntax:
rise.doc

rise.doc()
Args:

none

Returns:

none

1.6.2. Leaving/Quitting RISE

exit: remove the RISE Toolbox from the MATLAB path.

Syntax:
rise.exit
rise.exit()
Args:

none

Returns:

none

See also

rise.startup

1.6.3. Obtaining the release information

release : obtain release information

Syntax:
r=rise.release()
Inputs: None

Outputs:

r [char]: release information i.e. compatible Matlab versions

1.6.4. Starting RISE

STARTUP - add the RISE Toolbox to the MATLAB path and print the banner.

Syntax:
rise.startup() % or: rise_startup – load RISE, print the banner rise.startup(“quiet”) % or: rise_startup quiet – load RISE, one-line message rise.startup(true) % unload RISE (remove its folders from the path)

Args:

flag: false (default) -> load RISE and print the welcome banner;
“quiet”/”silent” -> load RISE, print only a one-line confirmation; true -> unload RISE.

Note:

Requires MATLAB R2023b or newer (RISE uses dictionary/configureDictionary).

See also

rise.exit

rise_exit

1.6.5. Obtaining the toolbox information

toolbox : provides toolbox information

Syntax:

 v=rise.toolbox()

Inputs: None

Outputs:

 - **v** [struct]: structure with information on

     #. The name of the toolbox
     #. Its version
     #. The Release i.e. the compatible version of Matlab
     #. The Date of the release

1.6.6. Obtaining the version of the Toolbox

version : current version of RISE

Syntax:
r=rise.version()
Inputs: None

Outputs:

r [char]: version tag

1.6.7. Why : Answers to random question rhyming with RISE

why(debug)

This function generates answers to the question “Why do we [verb]?” by providing random or specific responses related to different actions.

Parameters:

debug: A logical value or a word character (preferably ending in “rize”).

If set to true, the function will display all the possible responses.

If set to false (default), the function will randomly select and display one response.

If a word character is provided, the function will search for that specific response and display it.

Usage:

why() : Displays a random response to the question “Why do we [verb]?”.

why(true) : Displays all possible responses to the question “Why do we [verb]?”.

why(‘specific_word’)Displays the response related to the specific word, if found.
(e.g., why(‘polarize’) will display the response for polarize, if available.)

Examples:

why() Output: “Why do we accessorize? To add flair and personality to our outfits, transforming them from ordinary to extraordinary.”

why(true) Output:

“Why do we accessorize? To add flair and personality to our outfits, transforming them from ordinary to extraordinary.”

“Why do we catheterize? To ensure proper urinary function and provide necessary medical support in challenging situations.” … (Displays all possible responses)

why(‘polarize’) Output: “Why do we polarize? To create divisions or differences in opinion, beliefs, or attitudes, often leading to opposing or conflicting viewpoints.”

Note: The function includes a collection of pre-defined responses related to different actions. The responses can be modified or extended within the function code.

1.6.8. Whatsup : Random sentences rhyming with RISE

The whatstup function generates amusing and quirky sentences by combining various actions or concepts with humorous scenarios.

Syntax:

whatstup(debug)

whatstup(debug)

Description:

The whatstup function generates a sentence with a humorous scenario. The sentence is randomly selected from a collection of predefined sentences. By default, one sentence is printed to the command window. However, you can enable the debug mode to display all available sentences.

Input Arguments:

debug (optional): A logical value indicating whether to enable debug mode. When set to true, all available sentences are printed. If not provided, the default value is false.

Example usage:
>> whatstup() The polar bear decided to familiarize itself with the concept of sunbathing and started glamorizing its fur with sparkly sunscreen.

Notes :

The sentences generated by whatstup are meant to be humorous and entertaining. They combine actions or concepts with unexpected and funny scenarios.

The sentences may contain words that end in “rize,” which are highlighted using <strong> tags when displayed in debug mode.

Each time you call the whatstup function, a random sentence is selected from the collection of predefined sentences.