|
1 | 1 | #' Import and Manage BibTeX and BibLaTeX references with RefManageR |
2 | | -#' |
| 2 | +#' |
3 | 3 | #' RefManageR provides tools for importing and working with |
4 | 4 | #' bibliographic references. It greatly enhances the bibentry class by |
5 | 5 | #' providing a class BibEntry which stores BibTeX and BibLaTeX references, |
|
15 | 15 | #' @name RefManageR-package |
16 | 16 | #' @aliases RefManageR refmanager |
17 | 17 | #' @docType package |
18 | | -#' @author McLean, M. W. \email{mathew.w.mclean@@gmail.com} |
19 | | -#' @details |
| 18 | +#' @author McLean, M. W. \email{mathew.w.mclean@@gmail.com} |
| 19 | +#' @details |
20 | 20 | #' \bold{Importing and Creating References} |
21 | | -#' |
| 21 | +#' |
22 | 22 | #' BibEntry objects can be created directly using the \code{\link{BibEntry}} function. \code{.bib} files can be read into R |
23 | 23 | #' using the \code{\link{ReadBib}} function. |
24 | | -#' Tools are provided for importing references from Crossref, Zotero, Google Scholar, |
| 24 | +#' Tools are provided for importing references from Crossref, Zotero, Google Scholar, |
25 | 25 | #' and PDFs and looking up PubMed ID's and DOIs. See \code{\link{ReadPDFs}}, \code{\link{ReadZotero}}, \code{\link{ReadCrossRef}}, \code{\link{ReadGS}}, |
26 | 26 | #' \code{\link{ReadPubMed}}, \code{\link{GetPubMedByID}}, \code{\link{GetPubMedRelated}}. |
27 | | -#' |
| 27 | +#' |
28 | 28 | #' \bold{Manipulating BibEntry objects} |
29 | | -#' |
30 | | -#' BibEntry objects may be searched and indexed by field values, name lists, keys, dates, date ranges, etc. |
| 29 | +#' |
| 30 | +#' BibEntry objects may be searched and indexed by field values, name lists, keys, dates, date ranges, etc. |
31 | 31 | #' See \code{\link{[.BibEntry}}, \code{\link{[<-.BibEntry}}, \code{\link{[[.BibEntry}}, \code{\link{$.BibEntry}}. |
32 | | -#' |
| 32 | +#' |
33 | 33 | #' \bold{Printing and Exporting Bibliographies} |
34 | | -#' |
35 | | -#' The \code{\link{print.BibEntry}} function can print in a number of formats (e.g. text, html) and most of the |
36 | | -#' base bibliography styles available with BibLaTeX (e.g. alphabetic, numeric, authortitle, and authoryear). |
37 | | -#' \code{\link{toBibtex.BibEntry}} will convert a BibEntry object to a character vector containing lines of |
| 34 | +#' |
| 35 | +#' The \code{\link{print.BibEntry}} function can print in a number of formats (e.g. text, html) and most of the |
| 36 | +#' base bibliography styles available with BibLaTeX (e.g. alphabetic, numeric, authortitle, and authoryear). |
| 37 | +#' \code{\link{toBibtex.BibEntry}} will convert a BibEntry object to a character vector containing lines of |
38 | 38 | #' a BibTeX file, converting fields, entry types and expanding crossreferences as needed to coerce BibLaTeX entries to |
39 | | -#' BibTeX. \code{\link{toBiblatex}} converts the BibEntry object to a character vector containing lines of |
| 39 | +#' BibTeX. \code{\link{toBiblatex}} converts the BibEntry object to a character vector containing lines of |
40 | 40 | #' the corresponding BibLaTeX file. The results can be written to a file using \code{\link{WriteBib}}. |
41 | | -#' |
42 | | -#' Citations can be generated in a number of styles using one of the available functions for |
| 41 | +#' |
| 42 | +#' Citations can be generated in a number of styles using one of the available functions for |
43 | 43 | #' citations. A list of references can be printed based on the works the user has cited thus far |
44 | | -#' in their document. See \code{\link{Cite}}. The citations and bibliography can be printed |
| 44 | +#' in their document. See \code{\link{Cite}}. The citations and bibliography can be printed |
45 | 45 | #' including hyperlinks using either the R Markdown or R HTML formats. |
46 | | -#' |
| 46 | +#' |
47 | 47 | #' \bold{Additional features} |
48 | | -#' |
49 | | -#' All sorting methods for bibliographies available in the BibLaTeX LaTeX package have been implemented see |
| 48 | +#' |
| 49 | +#' All sorting methods for bibliographies available in the BibLaTeX LaTeX package have been implemented see |
50 | 50 | #' \code{\link{sort.BibEntry}} and the references. |
51 | | -#' |
| 51 | +#' |
52 | 52 | #' Using \code{\link{open.BibEntry}} electronic copies of references can be opened in a PDF viewer or web browser. |
53 | | -#' |
| 53 | +#' |
54 | 54 | #' The convenience function \code{\link{BibOptions}} is provided for setting defaults for commonly used |
55 | | -#' functions such as \code{\link{print.BibEntry}}, \code{\link{[.BibEntry}}, and |
| 55 | +#' functions such as \code{\link{print.BibEntry}}, \code{\link{[.BibEntry}}, and |
56 | 56 | #' \code{\link{Cite}}. Its interface is similar to \code{\link{options}}. |
57 | 57 | #' @keywords package |
58 | 58 | #' @references McLean, M. W. (2014). Straightforward Bibliography Management in R Using the RefManageR Package. |
59 | 59 | #' \href{https://arxiv.org/abs/1403.2036}{arXiv: 1403.2036 [cs.DL]}. Submitted. |
60 | 60 | #' @references Lehman, P., P. Kime, A. Boruvka, and J. Wright (2013). The biblatex Package. |
61 | | -#' \url{https://mirror.pregi.net/tex-archive/macros/latex/contrib/biblatex/doc/biblatex.pdf}. |
62 | | -#' @references Hornik, K., D. Murdoch, and A. Zeileis (2012). |
| 61 | +#' \url{https://texdoc.org/serve/biblatex/}. |
| 62 | +#' @references Hornik, K., D. Murdoch, and A. Zeileis (2012). |
63 | 63 | #' Who Did What? The Roles of R Package Authors and How to Refer to Them. The R Journal \bold{4}, 1. |
64 | 64 | #' \url{https://journal.r-project.org/archive/2012-1/RJournal_2012-1_Hornik~et~al.pdf} |
65 | | -#' @references Patashnik, O (1988). Bibtexing. \url{https://mirror.pregi.net/tex-archive/biblio/bibtex/contrib/doc/btxdoc.pdf}. |
| 65 | +#' @references Patashnik, O (1988). Bibtexing. \url{https://tug.org/texmf-docs/bibtex/btxdoc.pdf}. |
66 | 66 | NULL |
0 commit comments