add placeholders for use cases (#98)

cloudyr · Dec 21, 2015 · 30c3ed7 · 30c3ed7
1 parent 8c2d9d9
commit 30c3ed7
Show file tree

Hide file tree

Showing 7 changed files with 89 additions and 5 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: MTurkR
-Version: 0.6.20
-Date: 2015-12-18
+Version: 0.6.21
+Date: 2015-12-21
 Title: R Client for the MTurk Requester API
 Authors@R: c(person("Thomas J.", "Leeper", role = c("aut", "cre"),
                     email = "thosjleeper@gmail.com"),

diff --git a/NEWS b/NEWS
@@ -7,7 +7,7 @@
 * `HITStatus()` will now display any non-empty RequesterAnnotation field for a HIT. (#101)
 * The deprecated argument `print`, which was removed in v0.5, has been fully removed. Use `verbose` instead. (#97)
 * The deprecated functions `mturkrhelp` and `APIReference` have been removed. (#96)
-* `MTurkR.Wizard` has been removed from MTurkR and has been recreated as a separate package. (#95)
+* `MTurkR.Wizard` has been removed from MTurkR and has been recreated as a separate package called MTurkRGUI. (#95)
 * `HITStatus` now reports condensed column names better suited for narrow displays.
 * Correctly handle multiple `response.group` arguments passed to HIT-related functions. (#89)
 * `authenticate`, which was deprecated in v0.5, is removed.
@@ -18,6 +18,7 @@
 
 ## DOCUMENTATION ##
 
+* The package now includes pages describing common use cases for MTurk (surveys, categorization, sentiment analysis, and webscraping). (#98)
 * Descriptions of global package options have been added to MTurkR-package.Rd. (#103)
 * The package now includes additional HTMLQuestion templates including examples for image categorization and sentiment rating. (#94)
 * Documentation for `GenerateHITReviewPolicy` and `GenerateAssignmentReviewPolicy` was expanded and tested, and a related HTMLQuestion HIT template is now installed.

diff --git a/man/MTurkR-package.Rd b/man/MTurkR-package.Rd
@@ -34,10 +34,20 @@ Maintainer: Thomas J. Leeper <thosjleeper@gmail.com>
 
 \href{https://github.com/leeper/MTurkR/wiki}{The MTurkR Wiki}, which contains numerous code examples and tutorials.
 
-\href{https://github.com/leeper/MTurkRGUI}{The MTurkRGUI Package}, which provides a graphical user interface for MTurkR.
+\href{https://cran.r-project.org/web/packages/MTurkRGUI/index.html}{The MTurkRGUI Package}, which provides a graphical user interface for MTurkR.
 
 \href{http://aws.amazon.com/documentation/mturk/}{Amazon Mechanical Turk API Documentation}
 }
 \keyword{ package }
-%\seealso{}
+\seealso{
+
+To get started using MTurkR, see the documentation for \code{\link{CreateHIT}} (for creating single tasks) and/or \code{\link{BulkCreate}} (for creating batches of tasks). For some tutorials on how to use MTurkR for specific use cases, see the following:
+
+\itemize{
+    \item \link{survey}, for collecting survey(-experimental) data
+    \item \link{categorization}, for doing large-scale categorization (e.g., photo moderation or developing a training set)
+    \item \link{sentiment}, for doing sentiment coding
+    \item \link{webscraping}, for manual scraping of web data
+}
+}
 %\examples{}
diff --git a/man/UseCaseCategorization.Rd b/man/UseCaseCategorization.Rd
@@ -0,0 +1,18 @@
+\name{Use Case: Categorization}
+\alias{categorization}
+\concept{categorization}
+\concept{moderation}
+\concept{content moderation}
+\concept{photo moderation}
+\title{Use Case: Categorization}
+\description{This page describes how to use MTurkR to collect categorization data (perhaps for photo moderation or developing a training set) on Amazon Mechanical Turk.}
+%\details{}
+%\examples{\dontrun{}}
+\author{Thomas J. Leeper}
+\seealso{
+\code{\link{BulkCreate}}
+
+\code{\link{GetAssignments}}
+}
+\keyword{HITs}
+\keyword{Use Cases}
diff --git a/man/UseCaseScraping.Rd b/man/UseCaseScraping.Rd
@@ -0,0 +1,17 @@
+\name{Use Case: Webscraping}
+\alias{webscraping}
+\concept{scraping}
+\concept{webscraping}
+\concept{web scraping}
+\title{Use Case: Webscraping}
+\description{This page describes how to use MTurkR to scrape human-readable data from the web on Amazon Mechanical Turk.}
+%\details{}
+%\examples{\dontrun{}}
+\author{Thomas J. Leeper}
+\seealso{
+\code{\link{BulkCreate}}
+
+\code{\link{GetAssignments}}
+}
+\keyword{HITs}
+\keyword{Use Cases}
diff --git a/man/UseCaseSentiment.Rd b/man/UseCaseSentiment.Rd
@@ -0,0 +1,16 @@
+\name{Use Case: Sentiment Analysis}
+\alias{sentiment}
+\concept{sentiment}
+\concept{sentiment analysis}
+\title{Use Case: Sentiment Analysis}
+\description{This page describes how to use MTurkR to collect sentiment data on Amazon Mechanical Turk.}
+%\details{}
+%\examples{\dontrun{}}
+\author{Thomas J. Leeper}
+\seealso{
+\code{\link{BulkCreate}}
+
+\code{\link{GetAssignments}}
+}
+\keyword{HITs}
+\keyword{Use Cases}
diff --git a/man/UseCaseSurvey.Rd b/man/UseCaseSurvey.Rd
@@ -0,0 +1,22 @@
+\name{Use Case: Surveys}
+\alias{survey}
+\concept{survey}
+\concept{survey survey}
+\concept{survey panel}
+\concept{questionnaire}
+\title{Use Case: Surveys}
+\description{This page describes how to use MTurkR to collect survey(-experimental) data on Amazon Mechanical Turk.}
+%\details{}
+%\examples{\dontrun{}}
+\author{Thomas J. Leeper}
+\seealso{
+\code{\link{CreateHIT}}
+
+\code{\link{GetAssignments}}
+
+\code{\link{ContactWorkers}}
+
+\code{\link{GrantBonus}}
+}
+\keyword{HITs}
+\keyword{Use Cases}