Permalink
Browse files

Merge pull request #98 from billdenney/master

Fix #97, update documentation for citet
  • Loading branch information...
2 parents a9aeffb + 9834eab commit 2f6c10262c7932ff9cae987afaa7dd8e9022c55b @cboettig committed on GitHub Aug 19, 2016
Showing with 59 additions and 31 deletions.
  1. +10 −4 R/citep.R
  2. +13 −6 R/citet.R
  3. +17 −9 man/citep.Rd
  4. +19 −12 man/citet.Rd
View
@@ -1,4 +1,3 @@
-
#' citep - inline parenthetical citation
#'
#' Generate an inline parenthetical citation
@@ -19,9 +18,16 @@
#' many not be uniquely determined by the string. The most relevant search
#' result is returned, so consider refining search terms as necessary.
#' See examples.
-#' @return Format of tine parenthetical citation will depend on configuration.
-#' Unless citation_format = "pandoc", formatting is handled by Citep. See
-#' the arguments to Citep for details.
+#'
+#' @return Format of the parenthetical citation will depend on configuration.
+#' Unless citation_format = "pandoc", formatting is handled by
+#' \code{\link[RefManageR]{Citep}}. See the arguments to Citep for details.
+#' knitcitations will automatically track what has been cited during the
+#' active R session until the citation log is reset.
+#'
+#' @seealso \code{\link[RefManageR]{Citep}} for more details on the
+#' parenthetical citation generation. \code{\link{citet}} for generating
+#' inline text citations.
#'
#' @examples
#' # Cite an R package using the 'bibentry' object
View
@@ -1,6 +1,6 @@
-#' citet - inline parenthetical citation
+#' citet - inline text citation
#'
-#' Generate an inline parenthetical citation
+#' Generate an inline text citation
#' @param x a citation query, or list of queries for multiple citations. See details and examples
#' @param ... additional arguments for the search or formatting. See details.
#' @details the citation query can be any of:
@@ -18,10 +18,16 @@
#' many not be uniquely determined by the string. The most relevant search
#' result is returned, so consider refining search terms as necessary.
#' See examples.
-#' @return Format of tine parenthetical citation will depend on configuration.
-#' Unless citation_format = "pandoc", formatting is handled by Citet. See
-#' the arguments to Citet for details. knitcitations will automatically track
-#' what has been cited during the active R session until the citation log is reset
+#'
+#' @return Format of the text citation will depend on configuration. Unless
+#' citation_format = "pandoc", formatting is handled by
+#' \code{\link[RefManageR]{Citet}}. See the arguments to Citet for details.
+#' knitcitations will automatically track what has been cited during the
+#' active R session until the citation log is reset.
+#'
+#' @seealso \code{\link[RefManageR]{Citep}} for more details on the inline text
+#' citation generation. \code{\link{citep}} for generating parenthetical
+#' citations.
#'
#' @examples
#' # Cite an R package using the 'bibentry' object
@@ -31,6 +37,7 @@
#' # Cite using a search query and an optional argument
#' citet("Chamberlain taxize", year="2013")
#' }
+#'
#' @import RefManageR digest
#' @export
citet <- function(x, ...){
View

Some generated files are not rendered by default. Learn more.

Oops, something went wrong.
View

Some generated files are not rendered by default. Learn more.

Oops, something went wrong.

0 comments on commit 2f6c102

Please sign in to comment.