Skip to content

Commit

Permalink
doc review named range / named region
Browse files Browse the repository at this point in the history
  • Loading branch information
spoltier committed Apr 10, 2024
1 parent 63b44ae commit 842a4f8
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions man/createName-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
\alias{createName,workbook-method}
\title{Creating names in a workbook}
\description{
Creates a name for a specified formula in a \code{\linkS4class{workbook}}.
Creates a named range for a specified formula in a \code{\linkS4class{workbook}}.
}
\usage{
\S4method{createName}{workbook}(object, name, formula, overwrite, worksheetScope)
}

\arguments{
\item{object}{The \code{\linkS4class{workbook}} to use}
\item{name}{The name's name to create}
\item{name}{The name of the range to be created}
\item{formula}{Excel formula specifying the value / data the name refers to}
\item{overwrite}{If a name with the same \code{name} already exists
and \code{overwrite = TRUE}, then this name is removed first before
Expand All @@ -25,7 +25,7 @@ Creates a name for a specified formula in a \code{\linkS4class{workbook}}.
}

\details{
Creates a name named \code{name} for the specified \code{formula}.
Creates a named range called \code{name} for the specified \code{formula}.

The \code{formula} should be specified as you would type it
in Excel. Make sure that the worksheets, functions, ...
Expand Down
4 changes: 2 additions & 2 deletions man/existsName-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
\alias{existsName}
\alias{existsName-methods}
\alias{existsName,workbook-method}
\title{Checking existence of names in a workbook}
\title{Checking existence of named ranges in a workbook}
\description{
Checks the existence of a name in a \code{\linkS4class{workbook}}.
Checks the existence of a named range in a \code{\linkS4class{workbook}}.
}

\usage{
Expand Down
2 changes: 1 addition & 1 deletion man/getReferenceCoordinates-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
\alias{getReferenceCoordinates,workbook-method}
\title{Querying the coordinates of the range reference by an Excel name}
\description{
(DEPRECATED) Queries the coordinates of an Excel name in a \code{\linkS4class{workbook}}.
(DEPRECATED) Queries the coordinates of an Excel named range in a \code{\linkS4class{workbook}}.
}
\usage{
\S4method{getReferenceCoordinates}{workbook}(object,name)
Expand Down
6 changes: 3 additions & 3 deletions man/getReferenceCoordinatesForName-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
\alias{getReferenceCoordinatesForName,workbook-method}
\title{Querying the coordinates of the range reference by an Excel name}
\description{
Queries the coordinates of an Excel name in a \code{\linkS4class{workbook}}.
Queries the coordinates of an Excel named range in a \code{\linkS4class{workbook}}.
}
\usage{
\S4method{getReferenceCoordinatesForName}{workbook}(object,name, worksheetScope)
Expand All @@ -18,8 +18,8 @@ Queries the coordinates of an Excel name in a \code{\linkS4class{workbook}}.
\item{worksheetScope}{Optional, the name of the worksheet to use for resolving the named region}
}
\details{
If \code{worksheetScope} is defined, only coordinates for a name scoped strictly to the specified worksheet are
returned. To explicitly match only if the name is in the global scope, pass \code{""} as the value.
If \code{worksheetScope} is defined, only coordinates for a range scoped strictly to the specified worksheet are
returned. To explicitly only query for named ranges in the global scope, pass \code{""} as the value.
}

\author{
Expand Down
2 changes: 1 addition & 1 deletion man/readNamedRegion-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ readStrategy, worksheetScope)
}

\details{
The arguments \code{name} and \code{header} are vectorized. As such,
The arguments \code{name}, \code{header}, and \code{worksheetScope} are vectorized. As such,
multiple named regions can be read with one method call. If only one
single named region is read, the return value is a \code{data.frame}.If
multiple named regions are specified, the return value is a (named)
Expand Down
8 changes: 4 additions & 4 deletions man/removeName-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
\alias{removeName,workbook-method}
\title{Removing names from workbooks}
\description{
Removes a name from a \code{\linkS4class{workbook}}.
Removes a named range reference from a \code{\linkS4class{workbook}}.
}
\usage{
\S4method{removeName}{workbook}(object,name,worksheetScope)
Expand All @@ -15,12 +15,12 @@ Removes a name from a \code{\linkS4class{workbook}}.
\item{object}{The \code{\linkS4class{workbook}} to use}
\item{name}{The name to delete}
\item{worksheetScope}{Optional - the name of the worksheet in which the name is scoped;
useful if different sheets have scoped regions with the same name.}
useful if different sheets have locally-scoped named ranges with the same name.}
}

\details{
Removes the name named \code{name} from the specified workbook
\code{object} if it does exist. Multiple names can be specified to be removed.
Removes the named range reference \code{name} from the specified workbook \code{object} if it does exist.
Data in the referenced cells remains unchanged. Multiple names can be specified to be removed.
Use \code{worksheetScope = ""} to only target names defined in the global scope.
}
\author{
Expand Down
4 changes: 2 additions & 2 deletions man/writeNamedRegion-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
\alias{writeNamedRegion,workbook,ANY-method}
\title{Writing named regions to a workbook}
\description{
Writes named regions to a \code{\linkS4class{workbook}}.
Writes data to the named regions defined in a \code{\linkS4class{workbook}}.
}
\usage{
\S4method{writeNamedRegion}{workbook,ANY}(object, data, name, header,
Expand All @@ -26,7 +26,7 @@ Writes named regions to a \code{\linkS4class{workbook}}.
no row names will be included. May also be a \code{list} in case multiple data objects are
written in one call (see below).}
\item{worksheetScope}{Optional character vector with worksheet name(s) to limit the scope in
which the \code{name} is defined. By default the name is defined workbook-global.}
which the \code{name}(s) to write to is/are expected to be found}.
}

\details{
Expand Down

0 comments on commit 842a4f8

Please sign in to comment.