From fbe5c651a5f0958efbf1ee9ad70dce1ff35050d6 Mon Sep 17 00:00:00 2001 From: Jan-E Date: Fri, 4 Nov 2016 20:10:15 +0100 Subject: [PATCH 1/3] Improve docs on get_participants --- R/get_participants.R | 5 ++++- man/get_participants.Rd | 7 ++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/R/get_participants.R b/R/get_participants.R index c9e81f7..495aec5 100644 --- a/R/get_participants.R +++ b/R/get_participants.R @@ -8,7 +8,10 @@ #' @param aAttributes \dots #' @export #' @examples \dontrun{ -#' get_responses(12345) +#' get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=c('attribute_1','attribute_2')) +#' } +#' @examples \dontrun{ +#' get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=FALSE) #' } get_participants <- function(iSurveyID, iStart, iLimit, bUnused, aAttributes){ diff --git a/man/get_participants.Rd b/man/get_participants.Rd index a1117cf..8ebc300 100644 --- a/man/get_participants.Rd +++ b/man/get_participants.Rd @@ -22,7 +22,12 @@ This function exports and downloads the list of participants from a LimeSurvey s } \examples{ \dontrun{ -get_responses(12345) +get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=c('attribute_1','attribute_2')) +} +} +\examples{ +\dontrun{ +get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=FALSE)) } } From a83f351e98d099bed2ee32644b30ee4a21ae560b Mon Sep 17 00:00:00 2001 From: Jan-E Date: Fri, 4 Nov 2016 20:29:48 +0100 Subject: [PATCH 2/3] Fix \examples lines wider than 100 characters --- R/get_participants.R | 3 ++- man/get_participants.Rd | 5 +++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/R/get_participants.R b/R/get_participants.R index 495aec5..7917b8b 100644 --- a/R/get_participants.R +++ b/R/get_participants.R @@ -8,7 +8,8 @@ #' @param aAttributes \dots #' @export #' @examples \dontrun{ -#' get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=c('attribute_1','attribute_2')) +#' get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, +#' aAttributes=c('attribute_1','attribute_2')) #' } #' @examples \dontrun{ #' get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=FALSE) diff --git a/man/get_participants.Rd b/man/get_participants.Rd index 8ebc300..d8b0835 100644 --- a/man/get_participants.Rd +++ b/man/get_participants.Rd @@ -22,12 +22,13 @@ This function exports and downloads the list of participants from a LimeSurvey s } \examples{ \dontrun{ -get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=c('attribute_1','attribute_2')) +get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, + aAttributes=c('attribute_1','attribute_2')) } } \examples{ \dontrun{ -get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=FALSE)) +get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=FALSE) } } From 2a2f0e7cec497f4c88ece1c99b0451551bde97e6 Mon Sep 17 00:00:00 2001 From: Jan-E Date: Fri, 4 Nov 2016 20:36:05 +0100 Subject: [PATCH 3/3] Fix Only one \examples section is allowed --- R/get_participants.R | 2 -- man/get_participants.Rd | 4 ---- 2 files changed, 6 deletions(-) diff --git a/R/get_participants.R b/R/get_participants.R index 7917b8b..a98facf 100644 --- a/R/get_participants.R +++ b/R/get_participants.R @@ -10,8 +10,6 @@ #' @examples \dontrun{ #' get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, #' aAttributes=c('attribute_1','attribute_2')) -#' } -#' @examples \dontrun{ #' get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=FALSE) #' } diff --git a/man/get_participants.Rd b/man/get_participants.Rd index d8b0835..e505f62 100644 --- a/man/get_participants.Rd +++ b/man/get_participants.Rd @@ -24,10 +24,6 @@ This function exports and downloads the list of participants from a LimeSurvey s \dontrun{ get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=c('attribute_1','attribute_2')) -} -} -\examples{ -\dontrun{ get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=FALSE) } }