Skip to content

Commit

Permalink
Use roxygen2-like style for simple links
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelChirico committed Oct 14, 2024
1 parent c7dbb97 commit 338281c
Show file tree
Hide file tree
Showing 37 changed files with 262 additions and 262 deletions.
22 changes: 11 additions & 11 deletions man/all.equal.integer64.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
)
}
\arguments{
\item{target}{ a vector of 'integer64' or an object that can be coerced with \code{\link{as.integer64}} }
\item{target}{ a vector of 'integer64' or an object that can be coerced with code{link[=as.integer64]{as.integer64()}} }

\item{current}{ a vector of 'integer64' or an object that can be coerced with \code{\link{as.integer64}} }
\item{current}{ a vector of 'integer64' or an object that can be coerced with code{link[=as.integer64]{as.integer64()}} }

\item{tolerance}{numeric \eqn{\ge} 0. Differences smaller than
\code{tolerance} are not reported. The default value is close to
Expand All @@ -33,15 +33,15 @@
misleading in cases where \code{target} and \code{current} only
differ in a few places; see the extensive example.}

\item{formatFUN}{a \code{\link{function}} of two arguments,
\item{formatFUN}{a code{link[=function]{function()}} of two arguments,
\code{err}, the relative, absolute or scaled error, and
\code{what}, a character string indicating the \emph{kind} of error;
maybe used, e.g., to format relative and absolute errors differently.}

\item{...}{further arguments are ignored}

\item{check.attributes}{logical indicating if the
\code{\link{attributes}} of \code{target} and \code{current}
code{link[=attributes]{attributes()}} of \code{target} and \code{current}
(other than the names) should be compared.}
}
\value{
Expand All @@ -50,19 +50,19 @@
current.
}
\description{
A utility to compare integer64 objects 'x' and 'y' testing fornear equality’, see \code{\link{all.equal}}.
A utility to compare integer64 objects 'x' and 'y' testing fornear equality’, see code{link[=all.equal]{all.equal()}}.
}
\details{
In \code{\link{all.equal.numeric}} the type \code{integer} is treated as a proper subset of \code{double}
In code{link[=all.equal.numeric]{all.equal.numeric()}} the type \code{integer} is treated as a proper subset of \code{double}
i.e. does not complain about comparing \code{integer} with \code{double}.
Following this logic \code{all.equal.integer64} treats \code{integer} as a proper subset of \code{integer64}
and does not complain about comparing \code{integer} with \code{integer64}. \code{double} also compares without warning
as long as the values are within \code{\link{lim.integer64}}, if \code{double} are bigger \code{all.equal.integer64}
complains about the \code{all.equal.integer64 overflow warning}. For further details see \code{\link{all.equal}}.
as long as the values are within code{link[=lim.integer64]{lim.integer64()}}, if \code{double} are bigger \code{all.equal.integer64}
complains about the \code{all.equal.integer64 overflow warning}. For further details see code{link[=all.equal]{all.equal()}}.
}
\note{
\code{\link{all.equal}} only dispatches to this method if the first argument is \code{integer64},
calling \code{\link{all.equal}} with a \code{non-integer64} first and a \code{integer64} second argument
code{link[=all.equal]{all.equal()}} only dispatches to this method if the first argument is \code{integer64},
calling code{link[=all.equal]{all.equal()}} with a \code{non-integer64} first and a \code{integer64} second argument
gives undefined behavior!
}
\author{
Expand All @@ -75,5 +75,5 @@
all.equal(as.integer64(1), as.double(1e300))
}
\seealso{
\code{\link{all.equal}}
code{link[=all.equal]{all.equal()}}
}
8 changes: 4 additions & 4 deletions man/as.character.integer64.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
\arguments{
\item{x}{ an integer64 vector }

\item{...}{ further arguments to the \code{\link{NextMethod}} }
\item{...}{ further arguments to the code{link[=NextMethod]{NextMethod()}} }

\item{keep.names}{ FALSE, set to TRUE to keep a names vector }
}
Expand All @@ -41,8 +41,8 @@
\description{
Methods to coerce integer64 to other atomic types.
'as.bitstring' coerces to a human-readable bit representation (strings of zeroes and ones).
The methods \code{\link{format}}, \code{\link{as.character}}, \code{\link{as.double}},
\code{\link{as.logical}}, \code{\link{as.integer}} do what you would expect.
The methods code{link[=format]{format()}}, \code{\link{as.character}}, code{link[=as.double]{as.double()}},
code{link[=as.logical]{as.logical()}}, \code{\link{as.integer}} do what you would expect.
}
\author{
Jens Oehlschlägel <Jens.Oehlschlaegel@truecluster.com>
Expand All @@ -54,6 +54,6 @@ Jens Oehlschlägel <[email protected]>
-2,-1,NA,0:2
)))
}
\seealso{ \code{\link{as.integer64.character}} \code{\link{integer64}} }
\seealso{ code{link[=as.integer64.character]{as.integer64.character()}} \code{\link{integer64}} }
\keyword{ classes }
\keyword{ manip }
4 changes: 2 additions & 2 deletions man/as.data.frame.integer64.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
\arguments{
\item{x}{ an integer64 vector }

\item{...}{ passed to NextMethod \code{\link{as.data.frame}} after removing the 'integer64' class attribute }
\item{...}{ passed to NextMethod code{link[=as.data.frame]{as.data.frame()}} after removing the 'integer64' class attribute }
}
\value{
a one-column data.frame containing an integer64 vector
Expand All @@ -32,7 +32,7 @@ Jens Oehlschlägel <[email protected]>
data.frame(a=1:12, b=as.integer64(1:12))
}
\seealso{
\code{\link{cbind.integer64}} \code{\link{integer64}} %as.vector.integer64 removed as requested by the CRAN maintainer \code{\link{as.vector.integer64}}
code{link[=cbind.integer64]{cbind.integer64()}} \code{\link{integer64}} %as.vector.integer64 removed as requested by the CRAN maintainer \code{\link{as.vector.integer64}}
}
\keyword{ classes }
\keyword{ manip }
4 changes: 2 additions & 2 deletions man/as.integer64.character.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
\arguments{
\item{x}{ an atomic vector }

\item{...}{ further arguments to the \code{\link{NextMethod}} }
\item{...}{ further arguments to the code{link[=NextMethod]{NextMethod()}} }

\item{keep.names}{ FALSE, set to TRUE to keep a names vector }
}
Expand Down Expand Up @@ -79,6 +79,6 @@ as.integer64(
), class = "bitstring")
)
}
\seealso{ \code{\link{as.character.integer64}} \code{\link{integer64}} }
\seealso{ code{link[=as.character.integer64]{as.character.integer64()}} \code{\link{integer64}} }
\keyword{ classes }
\keyword{ manip }
12 changes: 6 additions & 6 deletions man/benchmark64.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ optimizer64(nsmall = 2^16, nbig = 2^25, timefun = repeat.time

\item{nbig}{ size of larger bigger vector }

\item{timefun}{ a function for timing such as \code{\link[bit]{repeat.time}} or \code{\link{system.time}} }
\item{timefun}{ a function for timing such as \code{\link[bit]{repeat.time}} or code{link[=system.time]{system.time()}} }

\item{what}{
a vector of names of high-level functions
}

\item{uniorder}{
one of the order parameters that are allowed in \code{\link{unique.integer64}} and \code{\link{unipos.integer64}}
one of the order parameters that are allowed in code{link[=unique.integer64]{unique.integer64()}} and code{link[=unipos.integer64]{unipos.integer64()}}
}

\item{taborder}{
one of the order parameters that are allowed in \code{\link{table.integer64}}
one of the order parameters that are allowed in code{link[=table.integer64]{table.integer64()}}
}

\item{plot}{
Expand All @@ -54,9 +54,9 @@ optimizer64(nsmall = 2^16, nbig = 2^25, timefun = repeat.time
\bold{scenario name} \tab \bold{explanation} \cr
32-bit \tab applying Base R function to 32-bit integer data \cr
64-bit \tab applying bit64 function to 64-bit integer data (with no cache) \cr
hashcache \tab dito when cache contains \code{\link{hashmap}}, see \code{\link{hashcache}} \cr
sortordercache \tab dito when cache contains sorting and ordering, see \code{\link{sortordercache}} \cr
ordercache \tab dito when cache contains ordering only, see \code{\link{ordercache}} \cr
hashcache \tab dito when cache contains code{link[=hashmap]{hashmap()}}, see code{link[=hashcache]{hashcache()}} \cr
sortordercache \tab dito when cache contains sorting and ordering, see code{link[=sortordercache]{sortordercache()}} \cr
ordercache \tab dito when cache contains ordering only, see code{link[=ordercache]{ordercache()}} \cr
allcache \tab dito when cache contains sorting, ordering and hashing \cr
}
\tabular{rl}{
Expand Down
2 changes: 1 addition & 1 deletion man/benchmark64.data.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
}
\usage{data(benchmark64.data)}
\description{
These are the results of calling \code{\link{benchmark64}}
These are the results of calling code{link[=benchmark64]{benchmark64()}}
}
\examples{
data(benchmark64.data)
Expand Down
Loading

0 comments on commit 338281c

Please sign in to comment.