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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ra-ref.R
\name{ra_ref}
\alias{ra_ref}
\title{ra_ref class}
\usage{
ra_ref(row_ref = 1L, row_abs = TRUE, col_ref = 1L, col_abs = TRUE,
sheet = NA_character_, file = NA_character_)
}
\arguments{
\item{row_ref}{integer, row or row offset}
\item{row_abs}{logical indicating whether \code{row_ref} is absolute or
relative}
\item{col_ref}{integer, column or column offset}
\item{col_abs}{logical indicating whether \code{col_ref} is absolute or
relative}
\item{sheet}{the name of a sheet (a.k.a. worksheet or tab)}
\item{file}{the name of a file (a.k.a. workbook)}
}
\value{
a \code{ra_ref} object
}
\description{
The \code{ra_ref} class is used to represent a single relative, absolute, or
mixed cell reference, presumably found in a formula. When \code{row_abs} is
\code{TRUE}, it means that \code{row_ref} identifies a specific row in an
absolute sense. When \code{row_abs} is \code{FALSE}, it means that
\code{row_ref} holds a positive, zero, or negative offset relative to the
address of the cell containing the formula that contains the associated cell
reference. Ditto for \code{col_abs} and \code{col_ref}.
}
\details{
A \code{ra_ref} object can also store the name of a sheet and a file, though
these will often be \code{NA}. A cell reference in a formula can potentially
be qualified like this: \code{[my_workbook.xlxs]Sheet1!R2C3}. In Testoft
(2014), he creates an entirely separate class for this, a \code{cell_ref},
which consists of a sheet- and file-ignorant \code{ra_ref} object and a sheet
reference (he doesn't allow formulas to refer to other files). I hope I
don't regret choosing a different path.
}
\section{Reference}{
Spreadsheet Implementation Technology: Basics and Extensions
Peter Sestoft
MIT Press 2014
}
\examples{
ra_ref()
ra_ref(row_ref = 3, col_ref = 2)
ra_ref(row_ref = 10, row_abs = FALSE, col_ref = 3, col_abs = TRUE)
ra_ref(sheet = "a sheet")
}
|
