File: insert_citeOnly.Rd

package info (click to toggle)
r-cran-rdpack 2.6.6-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,156 kB
  • sloc: sh: 13; makefile: 4
file content (69 lines) | stat: -rw-r--r-- 2,116 bytes parent folder | download | duplicates (2)
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
64
65
66
67
68
69
\name{insert_citeOnly}
\alias{insert_citeOnly}

\title{Generate citations from bibtex keys}

\description{Generate citations from bibtex keys.}

\usage{
insert_citeOnly(keys, package = NULL, before = NULL, after = NULL,
                bibpunct = NULL, ..., cached_env = NULL,
                cite_only = FALSE, dont_cite = FALSE)
}

\arguments{
  \item{keys}{

    a character string containing bibtex key(s) prefixed with the symbol
    \code{@}, intermixed with free text. The format is the same as for
    Rd macro \verb{\\insertCite}. Put \verb{;textual} at the end of the
    string to get a textual citation. Similarly, \verb{;nobrackets}
    requests parenthesised citation without the enclosing parentheses.
    Alternatively, \code{keys} can contain one or more keys, separated
    by commas.
  }
  \item{package}{name of an R package.}
  \item{before}{see \code{\link{citeNatbib}}.}
  \item{after}{see \code{\link{citeNatbib}}.}
  \item{bibpunct}{see \code{\link{citeNatbib}}.}
  \item{\dots}{further arguments; for internal use.}
  \item{cached_env}{for internal use.}
  \item{cite_only}{for internal use.}
  \item{dont_cite}{for internal use.}
}

\details{

  This is the function behind \verb{\\insertCite} and related macros.
  Argument \code{"keys"} has the syntax of the first argument of
  \verb{\\insertCite}, see \code{\link{insertRef}} for full details.

}

\value{
  a character vector containing the references with Rd markup
}
%\references{
%%% ~put references to the literature/web site here ~
%}
\author{Georgi N. Boshnakov}

\seealso{
  \code{\link{insert_ref}} for description of all available Rd macros
}

\examples{
insert_citeOnly("@see also @Rpackage:rbibutils and @parseRd", package = "Rdpack")
## (see also Boshnakov and Putman 2020 and Murdoch 2010)

insert_citeOnly("@see also @Rpackage:rbibutils and @parseRd;nobrackets",
  package = "Rdpack")
## see also Boshnakov and Putman 2020 and Murdoch 2010

insert_citeOnly("@see also @Rpackage:rbibutils and @parseRd;textual",
  package = "Rdpack")
## see also Boshnakov and Putman (2020) and Murdoch (2010)
}

\keyword{documentation}