roxygen regeneration; suggested changes from CRAN

cloudyr · Nov 24, 2021 · 8b81c0b · 8b81c0b
1 parent 696be0b
commit 8b81c0b
Show file tree

Hide file tree

Showing 54 changed files with 143 additions and 64 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: pyMTurkR
 Type: Package
 Title: A Client for the 'MTurk' Requester API
-Version: 1.1.4
+Version: 1.1.5
 Authors@R: c(person("Tyler", "Burleigh",
                     role = "aut", 
                     email = "[email protected]",

diff --git a/NAMESPACE b/NAMESPACE
@@ -133,6 +133,7 @@ export(listworkerblocks)
 export(notificationtest)
 export(notify)
 export(paybonus)
+export(pyMTurkR)
 export(qualrequests)
 export(qualscore)
 export(qualtype)

diff --git a/R/AccountBalance.R b/R/AccountBalance.R
@@ -13,7 +13,7 @@
 #' request. Note: list is returned invisibly.
 #' @author Tyler Burleigh, Thomas J. Leeper
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_GetAccountBalanceOperation.html}{API
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_GetAccountBalanceOperation.html}{API
 #' Reference}
 #'
 #' \href{https://requester.mturk.com/pricing}{MTurk Pricing Structure}

diff --git a/R/ApproveAssignment.R b/R/ApproveAssignment.R
@@ -31,10 +31,10 @@
 #' @author Tyler Burleigh, Thomas J. Leeper
 #' @seealso \code{\link{RejectAssignment}}
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ApproveAssignmentOperation.html}{API
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ApproveAssignmentOperation.html}{API
 #' Reference: Approve Assignment}
 #'
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ApproveRejectedAssignmentOperation.html}{API
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ApproveRejectedAssignmentOperation.html}{API
 #' Reference: Approve Rejected Assignment}
 #' @keywords Assignments
 #' @examples

diff --git a/R/AssignQualification.R b/R/AssignQualification.R
@@ -62,7 +62,7 @@
 #' valid.
 #' @author Tyler Burleigh, Thomas J. Leeper
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_AssignQualificationOperation.html}{API Reference}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_AssignQualificationOperation.html}{API Reference}
 #' @keywords Qualifications
 #' @examples
 #'

diff --git a/R/ChangeHITType.R b/R/ChangeHITType.R
@@ -63,7 +63,7 @@
 #'
 #' \code{\link{RegisterHITType}}
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ChangeHITTypeOfHITOperation.html}{API
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ChangeHITTypeOfHITOperation.html}{API
 #' Reference}
 #' @keywords HITs
 #' @examples

diff --git a/R/CreateQualificationType.R b/R/CreateQualificationType.R
@@ -51,7 +51,7 @@
 #' the newly created QualificationType.
 #' @author Tyler Burleigh, Thomas J. Leeper
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_CreateQualificationTypeOperation.html}{API
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_CreateQualificationTypeOperation.html}{API
 #' Reference}
 #' @keywords Qualifications
 #' @examples

diff --git a/R/GenerateExternalQuestion.R b/R/GenerateExternalQuestion.R
@@ -23,7 +23,7 @@
 #' @author Tyler Burleigh, Thomas J. Leeper
 #' @seealso \code{\link{CreateHIT}}
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ExternalQuestionArticle.html}{API Reference}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ExternalQuestionArticle.html}{API Reference}
 #' @keywords HITs
 #' @examples
 #'

diff --git a/R/GenerateHITsFromTemplate.R b/R/GenerateHITsFromTemplate.R
@@ -26,9 +26,9 @@
 #' template.
 #' @author Thomas J. Leeper
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/RequesterUI/CreatingaHITTemplate.html}{API Reference: Operation}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/RequesterUI/CreatingaHITTemplate.html}{API Reference: Operation}
 #'
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ExternalQuestionArticle.html}{API Reference: ExternalQuestion Data Structure}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ExternalQuestionArticle.html}{API Reference: ExternalQuestion Data Structure}
 #' @keywords HITs
 #' @examples
 #'

diff --git a/R/GenerateHTMLQuestion.R b/R/GenerateHTMLQuestion.R
@@ -37,7 +37,7 @@
 #'
 #' \code{\link{GenerateExternalQuestion}}
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_HTMLQuestionArticle.html}{API Reference}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_HTMLQuestionArticle.html}{API Reference}
 #' @keywords HITs
 #' @examples
 #'

diff --git a/R/GenerateNotification.R b/R/GenerateNotification.R
@@ -26,9 +26,9 @@
 #'
 #' \code{\link{SendTestEventNotification}}
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_NotificationDataStructureArticle.html}{API Reference}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_NotificationDataStructureArticle.html}{API Reference}
 #'
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMechanicalTurkRequester/Concepts_NotificationsArticle.html}{API Reference: Concept}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMechanicalTurkRequester/Concepts_NotificationsArticle.html}{API Reference: Concept}
 #' @keywords Notifications
 #' @export
 

diff --git a/R/GenerateReviewPolicy.R b/R/GenerateReviewPolicy.R
@@ -72,11 +72,11 @@
 #' \code{HITReviewPolicy} or \code{AssignmentReviewPolicy}.
 #' @author Tyler Burleigh, Thomas J. Leeper
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_QuestionFormDataStructureArticle.html}{API Reference: QuestionForm}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_QuestionFormDataStructureArticle.html}{API Reference: QuestionForm}
 #'
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ReviewPoliciesArticle.html}{API Reference (ReviewPolicies)}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ReviewPoliciesArticle.html}{API Reference (ReviewPolicies)}
 #'
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_HITReviewPolicyDataStructureArticle.html}{APIReference (Data Structure)}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_HITReviewPolicyDataStructureArticle.html}{APIReference (Data Structure)}
 #' @keywords HITs
 #' @examples
 #'

diff --git a/R/GetAssignment.R b/R/GetAssignment.R
@@ -50,6 +50,8 @@
 #' @param verbose Optionally print the results of the API request to the
 #' standard output. Default is taken from \code{getOption('pyMTurkR.verbose',
 #' TRUE)}.
+#' @return A data frame representing an assignment or multiple assignments for
+#' one or more HITs (or a HITType).
 #' @author Tyler Burleigh, Thomas J. Leeper
 #' @references
 #' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_GetAssignmentOperation.html}{API

diff --git a/R/GetClient.R b/R/GetClient.R
@@ -6,10 +6,11 @@
 #'
 #' \code{StartClient()} is an alias
 #'
-#' @aliases GetClient StartClient CheckAWSKeys
+#' @aliases GetClient StartClient
 #' @param sandbox A logical indicating whether the client should be in the
 #' sandbox environment or the live environment.
 #' @param restart.client A boolean that specifies whether to force the creation of a new client.
+#' @return No return value; Called to populate pyMTurkR$Client
 #' @author Tyler Burleigh
 #' @references
 #' \href{https://aws.amazon.com/sdk-for-python/}{AWS SDK for Python (Boto3)}
@@ -21,17 +22,12 @@
 #' }
 #' @export GetClient
 #' @export StartClient
-#' @export CheckAWSKeys
 
 GetClient <-
 StartClient <-
 function(sandbox = getOption('pyMTurkR.sandbox', TRUE),
          restart.client = FALSE){
 
-  if(!exists('pyMTurkR')){
-    pyMTurkR <<- new.env()
-  }
-
   helper_mturk_client <- function(sandbox, boto3){
 
     if(sandbox) endpoint_url <- 'https://mturk-requester-sandbox.us-east-1.amazonaws.com'
@@ -46,11 +42,13 @@ function(sandbox = getOption('pyMTurkR.sandbox', TRUE),
     }
 
     # Start client
-    pyMTurkR$Client <<- boto3$client('mturk', region_name='us-east-1',
+    client <- boto3$client('mturk', region_name='us-east-1',
                                     aws_access_key_id = key,
                                     aws_secret_access_key = secret_key,
                                     endpoint_url = endpoint_url)
 
+    assign("Client", client, envir=pyMTurkR)
+
     # Test credentials with a simple API call
     helper_mturk_credentials_test()
 
@@ -89,6 +87,13 @@ function(sandbox = getOption('pyMTurkR.sandbox', TRUE),
 }
 
 
+#' Helper function to check AWS Keys
+#'
+#' Checks for the existence of environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
+#'
+#' @return A logical indicating whether AWS Keys were found as environment variables.
+#' @export CheckAWSKeys
+#'
 CheckAWSKeys <- function(){
   if(Sys.getenv("AWS_ACCESS_KEY_ID") != "" & Sys.getenv("AWS_SECRET_ACCESS_KEY") != ""){
     return(TRUE)

diff --git a/R/GetHIT.R b/R/GetHIT.R
@@ -15,6 +15,7 @@
 #' @param verbose Optionally print the results of the API request to the
 #' standard output. Default is taken from \code{getOption('pyMTurkR.verbose',
 #' TRUE)}.
+#' @return A list of data frames of various details of a HIT.
 #' @author Tyler Burleigh, Thomas J. Leeper
 #' @references
 #' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_GetHITOperation.html}{API Reference}

diff --git a/R/GetReviewResultsForHIT.R b/R/GetReviewResultsForHIT.R
@@ -32,9 +32,9 @@
 #' @references
 #' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ListReviewPolicyResultsForHITOperation.html}{API Reference}
 #'
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ReviewPoliciesArticle.html}{API Reference (ReviewPolicies)}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_ReviewPoliciesArticle.html}{API Reference (ReviewPolicies)}
 #'
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_HITReviewPolicyDataStructureArticle.html}{API Reference (Data Structure)}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_HITReviewPolicyDataStructureArticle.html}{API Reference (Data Structure)}
 #' @keywords HITs
 #' @export
 

diff --git a/R/GetReviewableHITs.R b/R/GetReviewableHITs.R
@@ -24,7 +24,7 @@
 #' @return A data frame containing HITIds and Requester Annotations.
 #' @author Tyler Burleigh, Thomas J. Leeper
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_GetReviewableHITsOperation.html}{API Reference}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_GetReviewableHITsOperation.html}{API Reference}
 #' @keywords HITs
 #' @examples
 #'

diff --git a/R/SetHITTypeNotification.R b/R/SetHITTypeNotification.R
@@ -43,7 +43,7 @@
 #' @references
 #' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_UpdateNotificationSettingsOperation.html}{API Reference: Operation}
 #'
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMechanicalTurkRequester/Concepts_NotificationsArticle.html}{API Reference: Concept}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMechanicalTurkRequester/Concepts_NotificationsArticle.html}{API Reference: Concept}
 #' @keywords Notifications
 #' @examples
 #'

diff --git a/R/ToDataFrame.R b/R/ToDataFrame.R
@@ -1,6 +1,9 @@
 #' ToDataFrameHITs
-#' @aliases ToDataFrameHITs
+#'
+#' Convert a list of HITs to a data frame
+#'
 #' @param hits hits
+#' @return A data frame of information on HITs, one per row.
 #' @export
 ToDataFrameHITs <- function(hits) {
 
@@ -46,8 +49,8 @@ ToDataFrameHITs <- function(hits) {
 
 
 #' ToDataFrameReviewableHITs
-#' @aliases ToDataFrameReviewableHITs
 #' @param hits hits
+#' @return A Data frame of reviewable HIT information 
 #' @export
 ToDataFrameReviewableHITs <- function(hits) {
 
@@ -69,8 +72,8 @@ ToDataFrameReviewableHITs <- function(hits) {
 # QUALIFICATION STRUCTURES
 
 #' ToDataFrameQualificationRequirements
-#' @aliases ToDataFrameQualificationRequirements
 #' @param hits hits
+#' @return A Data frame of Qualification Requirements for the given HITs
 #' @export
 ToDataFrameQualificationRequirements <- function(hits) {
 
@@ -130,8 +133,11 @@ ToDataFrameQualificationRequirements <- function(hits) {
 # ASSIGNMENTS
 
 #' ToDataFrameAssignment
-#' @aliases ToDataFrameAssignment
+#'
+#' Get a list of assignment and answer information for an assignment
+#' 
 #' @param assignment assignment
+#' @return A list of Data frames, for assignment information and answers
 #' @export
 ToDataFrameAssignment <- function(assignment) {
 
@@ -192,9 +198,9 @@ ToDataFrameAssignment <- function(assignment) {
 # QUESTION FORM ANSWERS
 
 #' ToDataFrameQuestionFormAnswers
-#' @aliases ToDataFrameQuestionFormAnswers
 #' @param assignment assignment
 #' @param answers answers
+#' @return A Data frame of Answer information for the assignment 
 #' @export
 ToDataFrameQuestionFormAnswers <- function(assignment, answers) {
 
@@ -245,8 +251,8 @@ ToDataFrameQuestionFormAnswers <- function(assignment, answers) {
 # BLOCKED WORKERS
 
 #' ToDataFrameWorkerBlock
-#' @aliases ToDataFrameWorkerBlock
 #' @param workers workers
+#' @return A Data frame of blocked workers
 #' @export
 ToDataFrameWorkerBlock <- function(workers) {
 
@@ -268,8 +274,9 @@ ToDataFrameWorkerBlock <- function(workers) {
 # BONUS PAYMENTS
 
 #' ToDataFrameBonusPayments
-#' @aliases ToDataFrameBonusPayments
+#'
 #' @param bonuses bonuses
+#' @return A Data frame of Bonus payment information
 #' @export
 ToDataFrameBonusPayments <- function(bonuses){
 
@@ -301,6 +308,7 @@ ToDataFrameBonusPayments <- function(bonuses){
 #' ToDataFrameQualificationRequests
 #' @aliases ToDataFrameQualificationRequests
 #' @param requests requests
+#' @return A Data frame of Qualification Request information
 #' @export
 ToDataFrameQualificationRequests <- function(requests){
 
@@ -338,8 +346,8 @@ ToDataFrameQualificationRequests <- function(requests){
 
 
 #' ToDataFrameQualifications
-#' @aliases ToDataFrameQualifications
 #' @param quals qualifications
+#' @return A Data frame of qualification information 
 #' @export
 ToDataFrameQualifications <- function(quals){
 
@@ -388,8 +396,8 @@ ToDataFrameQualifications <- function(quals){
 
 
 #' ToDataFrameQualificationTypes
-#' @aliases ToDataFrameQualificationTypes
 #' @param quals qualifications
+#' @return A Data frame of Qualification Types
 #' @export
 ToDataFrameQualificationTypes <- function(quals) {
 
@@ -437,8 +445,8 @@ ToDataFrameQualificationTypes <- function(quals) {
 # REVIEW RESULTS
 
 #' ToDataFrameReviewResults
-#' @aliases ToDataFrameReviewResults
 #' @param results results
+#' @return A list of Data frames of Assignment Reviews/Actions and HIT Reviews/Actions.
 #' @export
 ToDataFrameReviewResults <- function(results) {
 

diff --git a/R/UpdateQualificationScore.R b/R/UpdateQualificationScore.R
@@ -41,7 +41,7 @@
 #'
 #' \code{\link{GetQualifications}}
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_UpdateQualificationScoreOperation.html}{API Reference}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_UpdateQualificationScoreOperation.html}{API Reference}
 #' @keywords Qualifications
 #' @examples
 #'

diff --git a/R/UpdateQualificationType.R b/R/UpdateQualificationType.R
@@ -45,7 +45,7 @@
 #'
 #' \code{\link{SearchQualificationTypes}}
 #' @references
-#' \href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_UpdateQualificationTypeOperation.html}{API Reference}
+#' \href{https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_UpdateQualificationTypeOperation.html}{API Reference}
 #' @keywords Qualifications
 #' @examples
 #'

diff --git a/R/emptydf.R b/R/emptydf.R
@@ -3,6 +3,7 @@
 #' @param nrow Number of rows
 #' @param ncol Number of columns
 #' @param names Number of names of the columns
+#' @return A data frame of NAs, with the given column names
 #' @export
 #'
 emptydf <- function(nrow, ncol, names) {

diff --git a/R/onLoad.r b/R/onLoad.r
@@ -1,9 +1,11 @@
+#' @export
+pyMTurkR <- new.env() 
+
 .onLoad <- function(libname, pkgname){
   if (is.null(getOption("pyMTurkR.sandbox"))) {
       options(pyMTurkR.sandbox = TRUE)     # sandbox logical
   }
   if (is.null(getOption("pyMTurkR.verbose"))) {
       options(pyMTurkR.verbose = TRUE)      # print logical
   }
-  pyMTurkR <<- new.env()
 }
diff --git a/man/AccountBalance.Rd b/man/AccountBalance.Rd