File: object_format.Rd

package info (click to toggle)
r-cran-roxygen2 7.3.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,940 kB
  • sloc: cpp: 351; sh: 14; makefile: 2
file content (20 lines) | stat: -rw-r--r-- 512 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/object-format.R
\name{object_format}
\alias{object_format}
\title{Default format for data}
\usage{
object_format(x)
}
\arguments{
\item{x}{A data object}
}
\value{
A \code{character} value with valid \code{Rd} syntax, or \code{NULL}.
}
\description{
This function is called to generate the default "Format" section for each
data object. The default implementation will return the class and dimension
information.
}
\keyword{internal}