-
-
Notifications
You must be signed in to change notification settings - Fork 19
/
Copy pathdrop_attributes_recursively.Rd
35 lines (33 loc) · 1.17 KB
/
drop_attributes_recursively.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils-query.R
\name{drop_attributes_recursively}
\alias{drop_attributes_recursively}
\title{Recursively remove attributes data from list}
\usage{
drop_attributes_recursively(
x,
object_name_append = FALSE,
object_name_as_col = FALSE
)
}
\arguments{
\item{x}{\code{list}; a list to be cleaned.}
\item{object_name_append}{\code{logical}; whether to include the object type
(e.g. Account or Contact) as part of the column names (e.g. Account.Name).}
\item{object_name_as_col}{\code{logical}; whether to include the object type
(e.g. Account or Contact) as a new column.}
}
\value{
\code{list} containing no 'attributes' elements with the object information
in the column names or the values within an object entitled \code{'sObject'}.
}
\description{
This function wraps the custom \code{drop_attributes} function that removes
elements from Salesforce data parsed to a list where the object type and the
record url persists because they were attributes on the record and not
part of the requested information.
}
\note{
This function is meant to be used internally. Only use when debugging.
}
\keyword{internal}