Package 'stickyr'

Title: Data Frames with Persistent Columns and Attributes
Description: Provides data frames that hold certain columns and attributes persistently for data processing in 'dplyr'.
Authors: Mizuki Uchida [aut, cre]
Maintainer: Mizuki Uchida <[email protected]>
License: MIT + file LICENSE
Version: 0.1.2
Built: 2024-11-16 03:03:19 UTC
Source: https://github.com/uchidamizuki/stickyr

Help Index

Coerce objects to sticky tibble

Description

'as_sticky_tibble' turns an object to a sticky tibble ('sticky_tbl_df').

Usage

as_sticky_tibble(x, ...)

Arguments

x

An object.
...

Unused, for extensibility.

Value

A sticky tibble ('sticky_tbl_df') object.

Test if the object is a sticky tibble

Description

Test if the object is a sticky tibble

Usage

is_sticky_tibble(x)

Arguments

x

An object

Value

TRUE if an object inherits from sticky_tbl_df, sticky_grouped_df or sticky_rowwise_df class.

Constructs a tibble with persistent columns and attributes

Description

new_sticky_tibble constructs a tibble with persistent columns and attributes. These persistent columns can be hidden.

Usage

new_sticky_tibble(
  x = list(),
  cols = NULL,
  col_show = tidyselect::everything(),
  col_summary = list(),
  attrs = character(),
  ...,
  class = character(),
  class_grouped_df = class,
  class_rowwise_df = class
)

Arguments

x

A tibble-like object.
cols

Columns to be kept persistently.
col_show

Which persistent columns to show? By default, all are displayed.
col_summary

A named list of functions to summarise persistent columns.
attrs

Names of attributes to be kept persistently.
...

Additional attributes.
class

Subclasses.
class_grouped_df

Subclasses of grouped_df. By default, it is the same as class.
class_rowwise_df

Subclasses of rowwise_df. By default, it is the same as class.

Value

A sticky tibble (sticky_tbl_df) object.