Skip to content

RefManageR #119

@mwmclean

Description

@mwmclean

Summary

  • What does this package do? (explain in 50 words or less):

Provides tools for importing and working with bibliographic references. Greatly enhances the bibentry class in R by providing a class BibEntry which stores BibTeX and BibLaTeX references, and can be easily searched by any field, by date ranges, and by various formats for name lists using R's person class.

  • Paste the full DESCRIPTION file inside a code block below:
Package: RefManageR
Version: 0.14.3
Date: 2017-06-02
Title: Straightforward 'BibTeX' and 'BibLaTeX' Bibliography Management
Authors@R: person(c("Mathew", "W."), "McLean", role = c("aut", "cre"),
    email = "[email protected]")
Author: Mathew W. McLean [aut, cre]
Maintainer: Mathew W. McLean <[email protected]>
Description: Provides tools for importing and working with bibliographic
    references. It greatly enhances the 'bibentry' class by providing a class
    'BibEntry' which stores 'BibTeX' and 'BibLaTeX' references, supports 'UTF-8'
    encoding, and can be easily searched by any field, by date ranges, and by
    various formats for name lists (author by last names, translator by full names,
    etc.). Entries can be updated, combined, sorted, printed in a number of styles,
    and exported. 'BibTeX' and 'BibLaTeX' '.bib' files can be read into 'R' and
    converted to 'BibEntry' objects. Interfaces to 'NCBI Entrez', 'CrossRef', and
    'Zotero' are provided for importing references and references can be created
    from locally stored 'PDF' files using 'Poppler'. Includes functions for citing
    and generating a bibliography with hyperlinks for documents prepared with
    'RMarkdown' or 'RHTML'.
License: GPL-2 | GPL-3 | BSD_3_clause + file LICENSE
Imports:
    xml2,
    jsonlite,
    utils,
    plyr,
    tools,
    httr,
    bibtex,
    lubridate (>= 1.5.0),
    stringr,
    methods
Suggests:
    knitr,
    testthat
Encoding: UTF-8
Depends:
    R (>= 3.0)
VignetteBuilder: knitr
BugReports: https://github.com/mwmclean/RefManageR/issues
RoxygenNote: 6.0.1
  • URL for the package (the development repository, not a stylized html page):

https://github.com/mwmclean/RefManageR

  • Please indicate which category or categories from our [package fit policies]

Reproducibility because it provides functions as well as vignette examples of working together with knitr to include references in reproducible reports. Data access because of the functions it provides for importing bibliographic information into R.

  • Who is the target audience?

Anyone that wants to write reproducible reports or simply organize bibliographic data from a variety of sources.

  • Are there other R packages that accomplish the same thing? If so, what is different about yours?

No package I'm aware of provides all the functionality, but there is some overlap with other packages.
Base R provides the bibentry class. RefManageR provides a class BibEntry that extends bibentry in a number of ways, such as support for BibLaTeX; improved handling of name list fields (author, editor, etc.); improved handling of dates (using lubridate); additional options for sorting, formatting, and printing; and additional methods that make it easier to search, sort, and modify parts of the BibEntry object. There is a small overlap with the packages rentrez and rcrossref, in that RefManageR can make use of the same APIs that those packages use to get references. However, RefManageR parses the results differently and returns a BibEntry object.

Requirements

Aside from the packages and version of R listed above in the DESCRIPTION, poppler is needed if a user want to extract bibliographic information from PDF files on their machine.

Confirm each of the following by checking the box. This package:

  • does not violate the Terms of Service of any service it interacts with.
  • has a CRAN and OSI accepted license.
  • contains a README with instructions for installing the development version.
  • includes documentation with examples for all functions.
  • contains a vignette with examples of its essential functions and uses.
  • has a test suite.
  • has continuous integration, including reporting of test coverage, using services such as Travis CI, Coeveralls and/or CodeCov.
  • I agree to abide by ROpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.

Publication options

  • Do you intend for this package to go on CRAN? (Has already been on CRAN for a few years)
  • Do you wish to automatically submit to the Journal of Open Source Software? If so:
    • The package contains a paper.md with a high-level description in the package root or in inst/.
    • The package is deposited in a long-term repository with the DOI:
    • (Do not submit your package separately to JOSS)

Note: I already submitted to JOSS here

Detail

  • Does R CMD check (or devtools::check()) succeed? Paste and describe any errors or warnings:

  • Does the package conform to rOpenSci packaging guidelines? Please describe any exceptions:

Exceptions: I did not follow your guidelines when naming the functions in my package since they were named long ago and have been on CRAN for a long time now (I used title case and no underscores).

  • If this is a resubmission following rejection, please explain the change in circumstances:

  • If possible, please provide recommendations of reviewers - those with experience with similar packages and/or likely users of your package - and their GitHub user names:
    @karthik @cboettig @sckott

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions