Skip to content

Commit

Permalink
Prepared CRAN submission.
Browse files Browse the repository at this point in the history
  • Loading branch information
crsh committed Sep 20, 2016
1 parent bd426a7 commit bee734b
Show file tree
Hide file tree
Showing 11 changed files with 44 additions and 43 deletions.
17 changes: 10 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
Package: citr
Type: Package
Title: RStudio Add-in to Insert Markdown Citations
Description: Functions and an RStudio add-in that search a BibTeX-file to create and
Title: 'RStudio' Add-in to Insert Markdown Citations
Description: Functions and an 'RStudio' add-in that search a 'BibTeX'-file to create and
insert formatted Markdown citations into the current document.
Version: 0.1.0.9029
Date: 2016-8-03
Authors@R: person("Frederik", "Aust", email = "[email protected]", role = c("aut", "cre"))
Version: 0.2.0
Date: 2016-9-20
Authors@R: c(
person("Frederik", "Aust", email = "[email protected]", role = c("aut", "cre")),
person("Yihui", "Xie", role = "ctb")
)
URL: https://github.com/crsh/citr
BugReports: https://github.com/crsh/citr/issues
Depends:
R (>= 3.0.0)
Imports:
RefManageR (>= 0.10.13),
RefManageR (>= 0.11.0),
yaml (>= 2.1.13),
rstudioapi (>= 0.5),
rstudioapi (>= 0.6),
miniUI (>= 0.1.1),
shiny (>= 0.13.2),
assertthat (>= 0.1),
Expand Down
7 changes: 7 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# citr 0.2.0

- Zotero/Juris-M library can now be accessed directly via the Better Bib(La)TeX extension (https://github.com/retorquere/zotero-better-bibtex). The document's bibliography file is updated accordingly. See `?insert_citation`.
- bibliography entries are no longer checked for missing fields (suggested by @awmercer, #8)
- If the current document is a child (i.e., included in a larger R Markdown document) the parent file is searched for bibliography paths (suggested and contributed to by @yihui, #7, #10)
- References in addin selection and inserted markdown citations are ordered alphabetically

# citr 0.1.0

Initial release.
2 changes: 1 addition & 1 deletion R/insert_citation.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#' @details The path to the Bib(La)TeX-file can be set in the global options and is set to
#' \code{./references.bib} when the package is loaded. Once the path is changed in the
#' RStudio addin, the global option is updated. If \code{use_betterbiblatex = TRUE} references
#' are imported from Zotero rather than from the Bib(La)TeX-file. The Bib(La)TeX-file
#' are imported from Zotero/Juris-M rather than from the Bib(La)TeX-file. The Bib(La)TeX-file
#' is then updated to include the inserted reference.
#'
#' If \code{insert_citation} is called while the focus is on a R Markdown document,
Expand Down
2 changes: 1 addition & 1 deletion R/md_cite.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#' @details The path to the BibTeX-file can be set in the global options and is set to
#' \code{references.bib} when the package is loaded. Once the path is changed in the
#' RStudio addin, the global option is updated. If \code{use_betterbiblatex = TRUE} references
#' are imported from Zotero rather than from the Bib(La)TeX-file. The Bib(La)TeX-file
#' are imported from Zotero/Juris-M rather than from the Bib(La)TeX-file. The Bib(La)TeX-file
#' is then updated to include the inserted reference.
#'
#' @return If the bibliography contains exactly one match the formated citation is returned, otherwise
Expand Down
8 changes: 4 additions & 4 deletions R/query_bib.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
#' @param bib_file Character. Path to Bib(La)TeX-file. See details.
#' @param cache Logical. If \code{cache = TRUE} cached bibliography is used, if available. If
#' \code{cache = FALSE} bibliography is re-imported on every function call.
#' @param use_betterbiblatex Logical. If \code{use_betterbiblatex = TRUE} references are imported from Zotero.
#' Requires that the \href{https://github.com/retorquere/zotero-better-bibtex}{Better Bib(La)TeX
#' for Zotero} is installed and Zotero is running.
#' @param use_betterbiblatex Logical. If \code{use_betterbiblatex = TRUE} references are imported from Zotero/Juris-M.
#' Requires that the \href{https://github.com/retorquere/zotero-better-bibtex}{Better Bib(La)TeX} is installed and
#' Zotero/Juris-M is running.
#'
#' @details The path to the BibTeX-file can be set in the global options and is set to
#' \code{references.bib} when the package is loaded. Once the path is changed in the
#' RStudio addin, the global option is updated. If \code{use_betterbiblatex = TRUE} references
#' are imported from Zotero rather than from the Bib(La)TeX-file. The Bib(La)TeX-file
#' are imported from Zotero/Juris-M rather than from the Bib(La)TeX-file. The Bib(La)TeX-file
#' is then updated to include the inserted reference.
#'
#' @return Returns list of class \code{\link[RefManageR]{BibEntry}} including all matching bibliography entries.
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "citr: RStudio Addin to Insert Markdown Citations"
output: github_document
---

[![CRAN status](http://www.r-pkg.org/badges/version/citr)](https://cran.r-project.org/web/packages/citr/index.html) [![Download counter](http://cranlogs.r-pkg.org/badges/citr)](https://cran.r-project.org/web/packages/citr/index.html)
[![CRAN status](http://www.r-pkg.org/badges/version/citr)](https://cran.r-project.org/package=citr) [![Download counter](http://cranlogs.r-pkg.org/badges/citr)](https://cran.r-project.org/package=citr)
[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
[![Build status](https://api.travis-ci.org/crsh/citr.svg?branch=master)](https://travis-ci.org/crsh/citr)

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
citr: RStudio Addin to Insert Markdown Citations
================

[![CRAN status](http://www.r-pkg.org/badges/version/citr)](https://cran.r-project.org/web/packages/citr/index.html) [![Download counter](http://cranlogs.r-pkg.org/badges/citr)](https://cran.r-project.org/web/packages/citr/index.html) [![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Build status](https://api.travis-ci.org/crsh/citr.svg?branch=master)](https://travis-ci.org/crsh/citr)
[![CRAN status](http://www.r-pkg.org/badges/version/citr)](https://cran.r-project.org/package=citr) [![Download counter](http://cranlogs.r-pkg.org/badges/citr)](https://cran.r-project.org/package=citr) [![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Build status](https://api.travis-ci.org/crsh/citr.svg?branch=master)](https://travis-ci.org/crsh/citr)

`citr` provides functions and an [RStudio addin](https://rstudio.github.io/rstudioaddins/) to search a BibTeX-file to create and insert formatted Markdown citations into the current document.

Expand Down
23 changes: 7 additions & 16 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,15 @@
* win-builder (devel and release)

## R CMD check results
There were no ERRORs or WARNINGs but 1 NOTE:
There were no ERRORs or WARNINGs but one NOTE:

> Maintainer: 'Frederik Aust <[email protected]>'
> New submission
> License components with restrictions and base license permitting such:
> MIT + file LICENSE
> File 'LICENSE':
> YEAR: 2016
> COPYRIGHT HOLDER: Frederik Aust
> Possibly mis-spelled words in DESCRIPTION:
> BibTeX (4:58)
> RStudio (3:8, 4:31)
Both spellings are customary.
Maintainer: 'Frederik Aust <[email protected]>'

License components with restrictions and base license permitting such:
MIT + file LICENSE
File 'LICENSE':
YEAR: 2016
COPYRIGHT HOLDER: Frederik Aust

## Downstream dependencies
There are no downstream dependencies.
8 changes: 4 additions & 4 deletions man/insert_citation.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/md_cite.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/query_bib.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit bee734b

Please sign in to comment.