rlistings (version 0.2.1)

listing_methods: Methods for listing_df objects

Description

See core documentation in formatters for descriptions of these functions.

Usage

# S3 method for listing_df
print(x, ...)
# S4 method for listing_df
[(x, i, j, drop = FALSE)
# S4 method for listing_df
main_title(obj)
# S4 method for listing_df
subtitles(obj)
# S4 method for listing_df
main_footer(obj)
# S4 method for listing_df
prov_footer(obj)
# S4 method for listing_df
main_title(obj) <- value
# S4 method for listing_df
subtitles(obj) <- value
# S4 method for listing_df
main_footer(obj) <- value
# S4 method for listing_df
prov_footer(obj) <- value

Value

for getter methods, the value of the aspect of obj; for setter methods, obj with the relevant element of the listing updated.

Arguments

x

listing_df. The listing.

...

dots. Unused

i

ANY. Passed to base [ methods.

j

ANY. Passed to base [ methods.

drop

For matrices and arrays. If TRUE the result is coerced to the lowest possible dimension (see the examples). This only works for extracting elements, not for the replacement. See drop for further details.

obj

The object.

value

typically an array-like R object of a similar class as x.

Examples

lsting <- as_listing(mtcars)
main_title(lsting) <- "Hi there"

main_title(lsting)