print.grates_month {grates}R Documentation

Format and print a month object

Description

Format and print a month object

Usage

## S3 method for class 'grates_month'
print(x, format = "%Y-%b", sep = "to", ...)

## S3 method for class 'grates_month'
format(x, format = "%Y-%b", sep = "to", ...)

Arguments

x

A ⁠<grates_month>⁠ object.

format

⁠[character]⁠

The format to use for the bounds of each value.

sep

⁠[character]⁠

Where more than one month is grouped with others, sep is placed between the upper and lower bounds when printing.

...

Not currently used.

Value

For format(), a character vector representing the formatted input. print() is called for the side effect of printing to screen and thus returns the input ⁠<grates_month>⁠ object invisibly.


[Package grates version 1.5.0 Index]