From 63268cd3f3f4af12934fd67160080704bd831465 Mon Sep 17 00:00:00 2001 From: jsta Date: Mon, 27 Jul 2020 10:56:25 -0400 Subject: [PATCH 1/2] improve category docs --- R/fs_add_categories.R | 2 +- R/fs_category_list.R | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/fs_add_categories.R b/R/fs_add_categories.R index 7ac219e..a4c077e 100644 --- a/R/fs_add_categories.R +++ b/R/fs_add_categories.R @@ -6,7 +6,7 @@ #' @param session (optional) the authentication credentials from \code{\link{fs_auth}}. If not provided, will attempt to load from cache as long as figshare_auth has been run. #' @param debug return PUT results visibly? #' @return output of PUT request (invisibly) -#' @seealso \code{\link{fs_auth}} +#' @seealso \code{\link{fs_auth}} \code{\link{fs_category_list}} #' @references \url{http://api.figshare.com} #' @import RJSONIO httr #' @export diff --git a/R/fs_category_list.R b/R/fs_category_list.R index f02230f..aca1cc7 100644 --- a/R/fs_category_list.R +++ b/R/fs_category_list.R @@ -7,7 +7,7 @@ #' @param debug enable debugging #' @export #' @examples \dontrun{ -#' fs_categories_list() +#' as.data.frame(rbind(fs_category_list())) #' } fs_category_list <- function(debug = FALSE){ response <- GET("http://api.figshare.com/v1/categories") From e15ae71524d4e4a1c225ae34b8e55b894f90c7c9 Mon Sep 17 00:00:00 2001 From: jsta Date: Mon, 27 Jul 2020 11:02:15 -0400 Subject: [PATCH 2/2] build category docs --- man/fs_add_categories.Rd | 10 +++++++--- man/fs_category_list.Rd | 2 +- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/man/fs_add_categories.Rd b/man/fs_add_categories.Rd index 994b108..5ed8682 100644 --- a/man/fs_add_categories.Rd +++ b/man/fs_add_categories.Rd @@ -4,8 +4,12 @@ \alias{fs_add_categories} \title{Add a category to article} \usage{ -fs_add_categories(article_id, category_id, session = fs_get_auth(), - debug = FALSE) +fs_add_categories( + article_id, + category_id, + session = fs_get_auth(), + debug = FALSE +) } \arguments{ \item{article_id}{the id number of the article} @@ -31,7 +35,7 @@ fs_add_categories(138, "Ecology") \url{http://api.figshare.com} } \seealso{ -\code{\link{fs_auth}} +\code{\link{fs_auth}} \code{\link{fs_category_list}} } \author{ Edmund Hart \email{edmund.m.hart@gmail.com} diff --git a/man/fs_category_list.Rd b/man/fs_category_list.Rd index 6bace02..1e7767a 100644 --- a/man/fs_category_list.Rd +++ b/man/fs_category_list.Rd @@ -17,7 +17,7 @@ List all categories } \examples{ \dontrun{ -fs_categories_list() +as.data.frame(rbind(fs_category_list())) } } \references{