mstrio (version 11.2.1)

Cube: Extract a MicroStrategy cube into a R Data.Frame

Description

Access, filter, publish, and extract data from MicroStrategy in-memory cubes

Attributes: connection: MicroStrategy connection object returned by `microstrategy.Connection()`. cube_id: Identifier of a pre-existing cube containing the required data. parallel (bool, optional): If True, use asynchronous requests to download data. If False (default), this feature will be disabled.

Public fields

connection

MicroStrategy connection object

cube_id

Identifier of a cube.

Methods

Public methods

• Cube$new()

• Cube$to_dataframe()

• Cube$apply_filters()

• Cube$clear_filters()

• Cube$get_attr_elements()

• Cube$clone()

Method new()

Usage

Cube$new(connection, cube_id, parallel = FALSE)

Method to_dataframe()

Usage

Cube$to_dataframe(
  limit = NULL,
  multi_df = FALSE,
  callback = function(x, y) { }
)

Method apply_filters()

Usage

Cube$apply_filters(attributes = NULL, metrics = NULL, attr_elements = NULL)

Method clear_filters()

Usage

Cube$clear_filters()

Method get_attr_elements()

Usage

Cube$get_attr_elements(verbose = TRUE)

Method clone()

The objects of this class are cloneable with this method.

Usage

Cube$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# NOT RUN {
# Create a connection object.
connection = connect_mstr(base_url, username, password, project_name)

# Create a cube object.
my_cube <- Cube$new(connection=conn, cube_id="...")

# See attributes and metrics in the report.
my_cube$attributes
my_cube$metrics
my_cube$attr_elements

# Specify attributes and metrics (columns) to be fetched.
my_cube$apply_filters(attributes = my_report$attributes[1:2],
                         metrics = my_report$metrics[1:2])

# See the selection of attributes, metrics and attribute elements.
my_cube$selected_attributes
my_cube$selected_metrics
my_cube$selected_attr_elements

# Clear filtering to load a full dataset.
my_cube$clear_filters()

# Fetch data from the Intelligence Server.
my_cube$to_dataframe()

# See the dataframe.
my_cube$dataframe
# }