File: document_range.Rd

package info (click to toggle)
r-cran-rstudioapi 0.17.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 916 kB
  • sloc: makefile: 2
file content (34 lines) | stat: -rw-r--r-- 888 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
21
22
23
24
25
26
27
28
29
30
31
32
33
34
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/document-methods.R
\name{document_range}
\alias{document_range}
\alias{is.document_range}
\alias{as.document_range}
\title{Create a Range}
\usage{
document_range(start, end = NULL)

is.document_range(x)

as.document_range(x)
}
\arguments{
\item{start}{A \code{\link{document_position}} indicating the start of the
range.}

\item{end}{A \code{\link{document_position}} indicating the end of the
range.}

\item{x}{An object coercable to \code{document_range}.}
}
\value{
An \code{list} with class \code{document_range} and fields:

\tabular{ll}{ \code{start:}\tab The start position.\cr \code{end:}\tab The
end position.\cr }
}
\description{
A \code{document_range} is a pair of \code{\link{document_position}}
objects, with each position indicating the \code{start} and \code{end} of
the range, respectively.
}