File: packageReference.Rd

package info (click to toggle)
r-cran-pkgmaker 0.32.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,192 kB
  • sloc: sh: 13; makefile: 2
file content (25 lines) | stat: -rw-r--r-- 779 bytes parent folder | download | duplicates (4)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bibtex.R
\name{packageReference}
\alias{packageReference}
\title{Package References}
\usage{
packageReference(key, short = FALSE, PACKAGE = NULL)
}
\arguments{
\item{key}{character vector of BibTex keys}

\item{short}{logical that indicates if the reference should be shorten as
First Author et al. if it has more than one author.}

\item{PACKAGE}{package in which the BiBTeX entry is defined.}
}
\value{
a character string containing the text formated BibTex entries
}
\description{
Create a citation string from package specific BibTex entries, suitable to
be used in Rd files.
The entries are looked in a file named REFERNCES.bib in the package's root
directory (i.e. inst/ in development mode).
}