From 21dcaf48b7372e1277c90f9c24c33fbaff4a967e Mon Sep 17 00:00:00 2001 From: Scott Chamberlain Date: Wed, 23 Nov 2016 11:55:38 -0800 Subject: [PATCH] tidy pkg level man file --- R/rplos-package.R | 20 ++++++++++++-------- man/rplos-defunct.Rd | 3 ++- man/rplos.Rd | 14 ++++++++------ 3 files changed, 22 insertions(+), 15 deletions(-) diff --git a/R/rplos-package.R b/R/rplos-package.R index 9372878..d8372f9 100644 --- a/R/rplos-package.R +++ b/R/rplos-package.R @@ -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: #' @@ -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) #' } #' @@ -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 @@ -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 diff --git a/man/rplos-defunct.Rd b/man/rplos-defunct.Rd index 980e9d3..1e021ac 100644 --- a/man/rplos-defunct.Rd +++ b/man/rplos-defunct.Rd @@ -5,7 +5,8 @@ \title{Defunct functions in rplos} \description{ \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} } } diff --git a/man/rplos.Rd b/man/rplos.Rd index 5d590c0..7eccf33 100644 --- a/man/rplos.Rd +++ b/man/rplos.Rd @@ -6,15 +6,16 @@ \alias{rplos-package} \title{Connect with PLoS API data} \description{ -\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}{ @@ -38,7 +39,8 @@ out <- searchplos(q="*:*", fl='id', fq='doc_type:full', start=0, limit=250) 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) }