Skip to content
This repository has been archived by the owner on Sep 9, 2022. It is now read-only.

Commit

Permalink
tidy pkg level man file
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Nov 23, 2016
1 parent abbdb13 commit 21dcaf4
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 15 deletions.
20 changes: 12 additions & 8 deletions R/rplos-package.R
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
#' Connect with PLoS API data
#'
#' \code{rplos} provides an R interface to the PLoS Search API. More information about each
#' function can be found in its help documentation. If you are looking for PLOS
#' article-Level metrics data, see the \code{alm} package.
#' \code{rplos} provides an R interface to the PLoS Search API. More
#' information about each function can be found in its help documentation.
#' If you are looking for PLOS article-Level metrics data, see the
#' \code{alm} package.
#'
#' @section rplos functions:
#'
#' Most rplos functions make web calls using the \code{httr} package, and parse json using
#' the \code{jsonlite} package.
#' Most rplos functions make web calls using the \code{httr} package,
#' and parse json using the \code{jsonlite} package.
#'
#' @section PLoS API key:
#'
Expand All @@ -26,7 +27,8 @@
#' head(out$data)
#'
#' # Get DOIs for only PLoS One articles
#' out <- searchplos(q="*:*", fl='id', fq='cross_published_journal_key:PLoSONE', start=0, limit=15)
#' out <- searchplos(q="*:*", fl='id', fq='cross_published_journal_key:PLoSONE',
#' start=0, limit=15)
#' head(out$data)
#' }
#'
Expand All @@ -38,7 +40,8 @@
#' @importFrom whisker whisker.render
#' @importFrom solr solr_highlight solr_facet
#' @importFrom lubridate now
#' @importFrom ggplot2 ggplot aes geom_bar theme_grey geom_line scale_colour_brewer labs theme
#' @importFrom ggplot2 ggplot aes geom_bar theme_grey geom_line
#' scale_colour_brewer labs theme
#' @docType package
#' @name rplos
#' @aliases rplos rplos-package
Expand All @@ -51,7 +54,8 @@ NULL
#' Defunct functions in rplos
#'
#' \itemize{
#' \item \code{\link{crossref}}: service no longer provided - see the package \code{rcrossref}
#' \item \code{\link{crossref}}: service no longer provided -
#' see the package \code{rcrossref}
#' }
#'
#' @name rplos-defunct
Expand Down
3 changes: 2 additions & 1 deletion man/rplos-defunct.Rd

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

14 changes: 8 additions & 6 deletions man/rplos.Rd

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

0 comments on commit 21dcaf4

Please sign in to comment.