transform_in_every_clusteringEntity.Rd
This function takes a full Rxs project object (as produced
by rxs_parseExtractionScripts()
) and processes all Rxs
trees, looking for clustering entities that match the entityId_regex
regular expression (for information about what clustering entities are,
see https://r-packages.gitlab.io/metabefor/articles/definitions.html)
and/or that contain a field matching the requiredField_regex
regular
expression, and passes those to function fun
with funArgs
as
arguments. For funArgs
, you can pass entity identifiers of clustered
entities contained in the clustering entity. These are then assigned the
corresponding name before fun
is called using do.call
. This allows
you to select values and rename them to match the function arguments.
transform_in_every_clusteringEntity(
x,
newEntityName,
fun,
funArgs,
entityId_regex = NULL,
requiredField_regex = NULL
)
The full Rxs project object (as produced
by rxs_parseExtractionScripts()
).
The name of the new entity to add to the clustering entity (i.e., the target entity's parent entity, a container entity).
The function to apply.
The arguments, as a character vector where each element is
a clustered entity stored in the clustering entity, and each element's name
is how that entity's value should be passed to fun
(allowing you to
specify that you want to pass, for example, uni.mean
and uni.sd
as
arguments mean
and sd
, respectively, to fun
). Anything in this vector
that is not the identifier of a clustered entity is passed as is.
An optional regular expression: if specified, only entity nodes with entity identifiers that match this regular expression will be processed.
An optional regular expression specifying a field that the clustering entity must contain for it to be processed.
Invisibly, the full Rxs project object. Note that the Rxs trees
will be changed in place given data.tree
's pass-by-reference logic; so
you can discard the result.