format_report_row: Format a single "rows" element from a report fact map

View source: R/utils-report.R

format_report_rowR Documentation

Format a single "rows" element from a report fact map

Description

This function accepts a list representing a single row from a report and selects either the value or label for the report columns to turn into a one row tbl_df that will usually be bound to the other rows in the report

Usage

format_report_row(
  x,
  labels = TRUE,
  guess_types = TRUE,
  bind_using_character_cols = deprecated()
)

Arguments

x

list; a single element from the rows element of a fact map. When the data is in a tabular format, this element usually has the same length as the number of columns with each element having a label and value element.

labels

logical; an indicator of whether the returned data should be the label (i.e. formatted value) or the actual value. By default, the labels are returned because these are what appear in the Salesforce dashboard and more closely align with the column names. For example, "Account.Name" label may be "Account B" and the value 0016A0000035mJEQAY. The former (label) more accurately reflects the "Account.Name".

guess_types

logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used along with anytime() and anydate(). If FALSE then all fields will be returned as character. Specifying FALSE helpful when guessing the column data type will result in NA values and you would like to return the results as strings and then cast in your script according to your unique specifications.

bind_using_character_cols

logical; an indicator of whether to cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be character.

Value

tbl_df; a single row data frame with the data for the row that the supplied list represented in the report's fact map.

Note

This function is meant to be used internally. Only use when debugging.


salesforcer documentation built on April 12, 2025, 9:12 a.m.