diff options
Diffstat (limited to '')
-rw-r--r-- | src/arrow/r/man/Field.Rd | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/src/arrow/r/man/Field.Rd b/src/arrow/r/man/Field.Rd new file mode 100644 index 000000000..3b709e879 --- /dev/null +++ b/src/arrow/r/man/Field.Rd @@ -0,0 +1,37 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/field.R +\docType{class} +\name{Field} +\alias{Field} +\alias{field} +\title{Field class} +\usage{ +field(name, type, metadata, nullable = TRUE) +} +\arguments{ +\item{name}{field name} + +\item{type}{logical type, instance of \link{DataType}} + +\item{metadata}{currently ignored} + +\item{nullable}{TRUE if field is nullable} +} +\description{ +\code{field()} lets you create an \code{arrow::Field} that maps a +\link[=data-type]{DataType} to a column name. Fields are contained in +\link[=Schema]{Schemas}. +} +\section{Methods}{ + +\itemize{ +\item \code{f$ToString()}: convert to a string +\item \code{f$Equals(other)}: test for equality. More naturally called as \code{f == other} +} +} + +\examples{ +\dontshow{if (arrow_available()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +field("x", int32()) +\dontshow{\}) # examplesIf} +} |