Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate high-level description for data objects #410

Merged
merged 5 commits into from
Oct 22, 2015
Merged

Generate high-level description for data objects #410

merged 5 commits into from
Oct 22, 2015

Conversation

krlmlr
Copy link
Member

@krlmlr krlmlr commented Oct 22, 2015

Currently very simple and very generic. Examples (from tests):

  • An object of class \code{list} of length 2.
  • An object of class \code{matrix} with 10 rows and 10 columns.
  • An object of class \code{data.frame} with 1 rows and 2 columns.
  • An object of class \code{array} of dimension 3 x 3 x 3.
  • An object of class \code{xtabs} (inherits from \code{table}) of dimension 3 x 2 x 3.

The format-generating function is an exported S3 generic, specialized formatters can be added easily, and packages should be able to supply custom formatters.

In the long run, it might be better to add the format from block_to_rd(), and not as default.

hadley added a commit that referenced this pull request Oct 22, 2015
Generate high-level description for data objects
@hadley hadley merged commit 479da39 into r-lib:master Oct 22, 2015
@hadley
Copy link
Member

hadley commented Oct 22, 2015

Thanks!

@krlmlr krlmlr deleted the default-format branch October 22, 2015 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants