Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
leeper committed Nov 11, 2015
0 parents commit f1f19a4
Show file tree
Hide file tree
Showing 12 changed files with 3,565 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.travis.yml
appveyor.yml
README.Rmd
README.html
MTurkRlog.tsv
drat.sh
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
README.Rmd
README.html
MTurkRlog.tsv
10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
language: r
sudo: required
r_github_packages:
- eddelbuettel/drat
after_success:
- test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && bash
drat.sh
env:
global:
secure: Kg4ZQvRHolP5lKs8HTwU7Tq8GoDFsL67HWwcpRSeIEJRxPiEo7Fz2OwsdRfXcG69Zl2PP6089HwAylrxoe4YiZUIFJPER4gJnkRz93Iq/K4QinBmtMzIDwIOds4y0pq0VFZJIQMNrgMtaIZFZyylYxfZbrSK25ynCGG/oFvaFGU=
12 changes: 12 additions & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Package: MTurkRGUI
Version: 0.1.1
Date: 2015-11-11
Title: A Graphical User Interface for MTurkR
Authors@R: c(person("Thomas J.", "Leeper", role = c("aut", "cre"),
email = "thosjleeper@gmail.com"))
Maintainer: Thomas J. Leeper <thosjleeper@gmail.com>
Imports: MTurkR, tcltk, grDevices, utils, XML, curl
Description: A graphical user interface (GUI) for the MTurkR package.
License: GPL-2
URL: https://github.com/leeper/MTurkRGUI
BugReports: https://github.com/leeper/MTurkRGUI/issues
8 changes: 8 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# imports
export("wizard")
import(MTurkR)
import(tcltk)
importFrom(XML, xmlParse)
importFrom(utils, browseURL)
importFrom(grDevices, bringToTop)
importFrom(curl, curl_escape)
3 changes: 3 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CHANGES TO MTurkRGUI 0.1.1 #

* Initial release.
3,393 changes: 3,393 additions & 0 deletions R/wizard.R

Large diffs are not rendered by default.

40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# A Graphical User Interface for MTurkR #

**MTurkRGUI** provides a graphical user interface for [MTurkR](http://cran.r-project.org/package=MTurkR).

## Installation ##

[![CRAN Version](http://www.r-pkg.org/badges/version/MTurkRGUI)](http://cran.r-project.org/package=MTurkRGUI)
![Downloads](http://cranlogs.r-pkg.org/badges/MTurkRGUI)
[![Travis-CI Build Status](https://travis-ci.org/leeper/MTurkRGUI.png?branch=master)](https://travis-ci.org/leeper/MTurkRGUI)

To install the latest development version of **MTurkRGUI** from GitHub:

```R
# latest stable version
install.packages("MTurkRGUI", repos = c(getOption("repos"), "http://cloudyr.github.io/drat"))

# latest (unstable) version from GitHub
if(!require("devtools")){
install.packages("devtools")
library("devtools")
}
install_github("leeper/MTurkRGUI")
```

To install the latest version from CRAN, simply use:

```R
install.packages("MTurkRGUI")
```

## Using **MTurkRGUI** ##

The MTurkR documentation files contain minimal examples for all functions. Further examples of how to use MTurkRGUI are provided in [the MTurkR GitHub wiki](https://github.com/leeper/MTurkR/wiki). Users can contribute their own examples or further documentation there, or via pull requests to the GitHub repository.

If you experience problems using MTurkRGUI, you can:

- [Report issues on Github](https://github.com/leeper/MTurkRGUI/issues)
- Contact the package maintainer [via email](mailto:thosjleeper@gmail.com) or on [Twitter](https://twitter.com/thosjleeper)

[![cloudyr project logo](http://i.imgur.com/JHS98Y7.png)](https://github.com/cloudyr)
23 changes: 23 additions & 0 deletions drat.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#!/bin/bash
set -o errexit -o nounset
addToDrat(){
mkdir drat; cd drat

## Set up Repo parameters
git init
git config user.name "leeper"
git config user.email "thosjleeper@gmail.com"
git config --global push.default simple

## Get drat repo
git remote add upstream "https://$GH_TOKEN@github.com/cloudyr/cloudyr.github.io.git"
git fetch upstream
git checkout master

Rscript -e "drat::insertPackage('../$PKG_TARBALL', repodir = './drat')"
git add --all
git commit -m "add $PKG_TARBALL (build $TRAVIS_BUILD_ID)"
git push

}
addToDrat
15 changes: 15 additions & 0 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
citHeader("To cite package 'MTurkRGUI' in publications use:")

year <- sub(".*(2[[:digit:]]{3})-.*", "\\1", meta$Date, perl = TRUE)
vers <- paste("R package version", meta$Version)

citEntry(entry="Manual",
title = "MTurkRGUI: A Graphical User Interface for MTurkR",
author = personList(as.person("Thomas J. Leeper")),
year = year,
note = vers,
textVersion =
paste("Thomas J. Leeper (",
year,
"). MTurkRGUI: A Graphical User Interface for MTurkR. ",
vers, ".", sep=""))
30 changes: 30 additions & 0 deletions man/GUI.Rd
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
\name{wizard}
\alias{MTurkR.Wizard}
\alias{mturkr.wizard}
\alias{wizard}
\title{Interactive MTurkR Mode}
\description{An interactive, menu-based wizard to perform MTurkR functions. Designed for beginners and those with aversion to the programming required elsewhere in the package.}
\usage{
wizard(style = "tcltk", sandbox = getOption('MTurkR.sandbox'))
}
\arguments{
\item{style}{The default \code{tcltk}, opens a full-featured GUI for MTurkR. \code{simple} opens a simpler, text-based wizard (provided by \code{\link[MTurkR]{wizard.simple}}) for performing some functions; \code{simpleGUI} opens the same simpler wizard, with graphical rather than text-based menus.}
\item{sandbox}{Optionally execute all requests in the MTurk sandbox rather than the live server. Default (in \code{wizard}) is FALSE; the default in \code{\link[MTurkR]{wizard.simple}} is NULL (with the wizard prompting for a value on load.}
}
\details{
An interactive, menu-based wizard (with optionally graphical menus) to perform most MTurkR operations. It is intended as a way for MTurk (and MTurkR) beginners to quickly create and monitor HITs; approve and reject assignments; notify, bonus, and block/unblock workers; manage Qualifications; monitor MTurk statistics; and interact with the MTurk Requester User Interface (RUI). All functionality accepts basic inputs interactively and executes requests without programming individual commands.

Two particularly helpful features are worth highlighting. The wizard provides a point-and-click interface for approving and rejecting individual assignments, that interactively displays assignment content and executes approval/rejection decisions with ease. The wizard also provides analogous functionality for granting and rejecting qualification requests.

The wizard remains under active development and detailed documentation will hopefully be available under a subsequent release.
}
\value{Currently returns nothing.}
%\references{}
\author{Thomas J. Leeper}
%\note{}
%\seealso{}
\examples{
\dontrun{
wizard()
}
}
22 changes: 22 additions & 0 deletions man/MTurkRGUI-package.Rd
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
\name{MTurkRGUI-package}
\alias{MTurkRGUI-package}
\alias{MTurkRGUI}
\docType{package}
\title{A graphical user interface (GUI) for the MTurkR package.}
\description{
This package provides a graphical user interface for the MTurkR package. The functionality was previously part of MTurkR, but has been factored out into a separate package to simply development. Users should see the MTurkR documentation for }
\author{
Thomas J. Leeper

Maintainer: Thomas J. Leeper <thosjleeper@gmail.com>
}
\references{
\href{http://www.mturk.com}{Amazon Mechanical Turk}

\href{http://aws.amazon.com/documentation/mturk/}{Amazon Mechanical Turk API Documentation}

\href{http://www.github.com/leeper/MTurkR}{MTurkR Wiki}
}
\keyword{ package }
%\seealso{}
%\examples{}

0 comments on commit f1f19a4

Please sign in to comment.