grp_pull {gt}

Pull out a gt table from a gt_group container object

Description

Should you have a gt_group object, created through use of the gt_group() function, you may have a need to extract a gt table from that container. The grp_pull() function makes this possible, returning a gt_tbl object. The only thing you need to provide is the index value for the gt table within the gt_group object.

Usage

grp_pull(data, which)

Arguments

data

The gt table group object

⁠obj:<gt_group>⁠ // required

This is a gt_group container object. It is typically generated through use of the gt_group() function along with one or more gt_tbl objects, or, made by splitting a gt table with gt_split().

which

The table to pull from the group

⁠scalar<numeric|integer>⁠ // required

A single index value denoting which gt_tbl table should be obtained from the gt_group object.

Value

An object of class gt_tbl.

Function ID

14-3

Function Introduced

v0.9.0 (Mar 31, 2023)

See Also

Other table group functions: grp_add(), grp_clone(), grp_options(), grp_replace(), grp_rm(), gt_group(), gt_split()