Skip to content

Commit

Permalink
Adding installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
pmcharrison committed Jun 28, 2018
1 parent 4570635 commit 2115624
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions installation-instructions.txt
@@ -0,0 +1,38 @@
* Installation steps *

Create a (free) account on https://bitbucket.org/.

You should have received an invitation from Bitbucket to a repository entitled ‘psychTestR’. Accept this invitation with your Bitbucket account (let me know if you need me to send an invitation to a different email address.

Open RStudio on your computer.

Install the ‘devtools’ package by running the following command at the R terminal:
install.packages('devtools')

Install psychTestR:
devtools::install_bitbucket('pmcharrison/psychTestR', auth_user = 'your_bitbucket_email_address', password = 'your_bitbucket_password')

Install the melody discrimination test:
devtools::install_github('pmcharrison/mdt')
You should now have everything installed.
* Running the test *

Open RStudio.

Load the melody discrimination test:
library(mdt)

Here are some example commands you can run:

# Run a demo test, with feedback as you progress through the test, and not saving your data
demo_mdt()

# Run a demo test, skipping the training phase, and only asking 5 questions
demo_mdt(num_items = 5, take_training = FALSE)

# Run the test as if for a participant, using all default settings, saving data, and with a custom admin password
standalone_mdt(admin_password = "my-password")

0 comments on commit 2115624

Please sign in to comment.