| type_sum {pillar} | R Documentation |
type_sum() gives a brief summary of object type. Objects that commonly
occur in a data frame should return a string with four or less characters.
For most inputs, the argument is forwarded to vctrs::vec_ptype_abbr().
obj_sum() also includes the size of the object if vctrs::vec_is()
is TRUE.
It should always return a string (a character vector of length one).
size_sum() is called by obj_sum() to format the size of the object.
It should always return a string (a character vector of length one),
it can be an empty string "" to omit size information,
this is what the default method does for scalars.
type_sum(x) obj_sum(x) size_sum(x)
x |
an object to summarise. Generally only methods of atomic vectors and variants have been implemented. |
type_sum() is in the "questioning" stage, because vctrs::vec_ptype_abbr()
provides essentially the same functionality based on a robust framework.
The generic will remain available for a while.
Users and implementers are encouraged to consider vctrs::vec_ptype_abbr()
once it becomes stable.
obj_sum(1:10) obj_sum(matrix(1:10)) obj_sum(Sys.Date()) obj_sum(Sys.time()) obj_sum(mean) size_sum(1:10) size_sum(trees) size_sum(Titanic)