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 60 61 62 63
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/registry.R
\name{regfetch}
\alias{regfetch}
\alias{pkgreg_fetch}
\alias{pkgreg_remove}
\title{Finds an entry in a registry.}
\usage{
regfetch(regobj, ..., all = FALSE, error = TRUE, exact = FALSE,
KEYS = NULL, verbose = FALSE, entry = FALSE, msg = NULL)
pkgreg_fetch(regname, ..., msg = NULL, where = topenv(parent.frame()))
pkgreg_remove(regname, ..., msg = NULL, where = topenv(parent.frame()),
quiet = FALSE)
}
\arguments{
\item{regobj}{a registry object}
\item{...}{key value(s) to look up.
If multiple indexes are used, then the primary key should come first.}
\item{all}{logical to indicate if hidden keys (starting with a '.') should be
returned and output in message.}
\item{error}{a logical that indicates if an error should be thrown if the key has no match
or multiple matches}
\item{exact}{a logical that indicates if matching should be exact or partial.
Note that if exact matches exist then they are returned, independently of the
value of \code{exact}.}
\item{KEYS}{alternative way of passing the key value(s).
If not missing, then arguments in \code{...} are discarded.}
\item{verbose}{a logical that indicates if verbosity should be toggle on}
\item{entry}{a logical that indicates if the}
\item{msg}{a header to use in case of error.}
\item{regname}{Name of a sub-registry, used as its identifier.}
\item{where}{package name or namespace that owns the registry.}
\item{quiet}{a logical that indicates if the operation should be performed quietly,
without throwing errors or warnings.}
}
\description{
This function provides extra control on how entries are queried
from a \code{\link[registry:regobj]{registry}} object.
}
\section{Functions}{
\itemize{
\item \code{pkgreg_fetch}: fetches entries in a package registry, as set up by
\code{\link{setPackageRegistry}}.
It loads the requested package registry and uses \code{regfetch}
to retrieve data from it.
\item \code{pkgreg_remove}: removes an entry from a package registry.
}}
|