Before you start
- Exploratory Desktop is running and the project is open (Choose a project). Check with expl status.
- You know the id of the data frame and its column names (expl dataframe list and expl dataframe get-schema <dataframe_id>).
- analytics add and analytics edit work only when Allow create, edit and delete is on in System Settings > MCP / CLI. They do not ask for confirmation; deleting analytics does. See Confirmation and long-running operations.
Steps
1. Pick the type of analytics
2. Look up its slots and settings
3. Create it
--analysis-type and --slots are required. --slots is a JSON object that puts column names in the slots, with the slot name as the key: a string for a slot of one column, an array for a slot of several columns. --settings takes a JSON object of the setting names from step 2 (a true or false setting is the string “TRUE” or “FALSE”).
{"cor_method": "spearman"}. Other types have other slot and setting names, so copy them from get-template. The command creates the analytics and runs it. The result carries the id (analyticsId) and the state of each output.
4. Read the result
--output-type.
5. Change it
--slots, --settings, --title, --analysis-type and so on. It runs the analytics again; if that fails, the definition goes back to the one before.
If it fails
For the arguments of any command, run
expl <command> --help or expl tools describe "<command>".
