Difference between revisions of "Radcloud Experiment management"

From TSG Doc
Jump to navigation Jump to search
(Created page with "== Experiment manager == === Introduction === Welcome to Radcloud! This application allows users to manage data stored from web experiments, including creating new experiment...")
 
 
Line 17: Line 17:
 
#* Navigate to the Radcloud experiment management interface: [Radcloud](https://radcloud.socsci.ru.nl/).
 
#* Navigate to the Radcloud experiment management interface: [Radcloud](https://radcloud.socsci.ru.nl/).
 
#* You will be directed to the login page.
 
#* You will be directed to the login page.
 
[[File:screenshots/img.png]]
 
  
 
# '''Enter Credentials'''
 
# '''Enter Credentials'''
Line 30: Line 28:
 
# '''Navigate to the Experiment Table'''
 
# '''Navigate to the Experiment Table'''
 
#* Once logged in, click on the "Create Experiment" button in the dashboard.
 
#* Once logged in, click on the "Create Experiment" button in the dashboard.
 
[[File:screenshots/experiment_toolbar.png]]
 
  
 
# '''Enter Experiment Details'''
 
# '''Enter Experiment Details'''
 
#* Fill in the required fields such as Experiment Title, Supervisor e-mail.
 
#* Fill in the required fields such as Experiment Title, Supervisor e-mail.
 
[[File:screenshots/create_experiment.png]]
 
  
 
# '''Save Experiment'''
 
# '''Save Experiment'''
Line 55: Line 49:
 
#* Choose the preferred format (CSV, JSON, etc.).
 
#* Choose the preferred format (CSV, JSON, etc.).
 
#* In the Selected Data section, click on the "Download Data" button.
 
#* In the Selected Data section, click on the "Download Data" button.
 
[[File:screenshots/Screenshot_2024-06-10_at_10.51.25.png]]
 
  
 
==== Uploading Experiment Data ====
 
==== Uploading Experiment Data ====
Please continue to read [[Datahandler script]] for documentation on adding the datahandler script to your social web experiment.
+
Please continue to read [[Radcloud_Datahandler_script|Datahandler script]] for documentation on adding the datahandler script to your social web experiment.
Go to [[Radcloud API]] for API documentation if you want to communicate with the Radcloud API directly from your own code.
+
Go to [[Radcloud_API-examples|Radcloud API]] for API documentation if you want to communicate with the Radcloud API directly from your own code.
  
 
==== Copying the API Key ====
 
==== Copying the API Key ====
Line 68: Line 60:
 
# '''Locate API Key'''
 
# '''Locate API Key'''
 
#* Find the column labeled "API Key".
 
#* Find the column labeled "API Key".
 
[[File:screenshots/Screenshot_2024-06-10_at_10.20.36.png]]
 
  
 
# '''Copy API Key'''
 
# '''Copy API Key'''
 
#* Click the "Copy" icon button next to the experiment you want to use in your web experiment to copy it to your clipboard.
 
#* Click the "Copy" icon button next to the experiment you want to use in your web experiment to copy it to your clipboard.
 
[[File:screenshots/Screenshot_2024-10-23_at_11.50.40.png]]
 
  
 
==== Deleting Participant Data ====
 
==== Deleting Participant Data ====
Line 106: Line 94:
 
* '''Q: What data formats are available for download?'''
 
* '''Q: What data formats are available for download?'''
 
** A: CSV and JSON formats are available for download.
 
** A: CSV and JSON formats are available for download.
 
[[File:screenshots/Screenshot_2024-10-23_at_11.47.28.png]]
 
[[File:screenshots/Screenshot_2024-10-23_at_11.48.54.png]]
 
  
 
* '''Q: How do I copy my API key?'''
 
* '''Q: How do I copy my API key?'''

Latest revision as of 10:35, 11 February 2025

Experiment manager

Introduction

Welcome to Radcloud! This application allows users to manage data stored from web experiments, including creating new experiments, downloading experiment data, and managing participant data. The Radcloud experiment management tool can be accessed [here](https://radcloud.socsci.ru.nl/).

Getting Started

System Requirements

  • A modern web browser (Chrome, Firefox)
  • Internet connection

Installation

No installation is required. Simply access the web application via the provided URL: [Radcloud](https://radcloud.socsci.ru.nl/).

User Guide

Login

  1. Access the Login Page
  1. Enter Credentials
    • Enter your RU-account email address and password.
    • Click on the "Login" button.

User Interface View

Radcloud offers two view types:

Create an Experiment

  1. Navigate to the Experiment Table
    • Once logged in, click on the "Create Experiment" button in the dashboard.
  1. Enter Experiment Details
    • Fill in the required fields such as Experiment Title, Supervisor e-mail.
  1. Save Experiment
    • After entering all necessary information, click on the "Save Experiment" button.
    • You will receive a confirmation that your experiment has been created.

Downloading Experiment Data

  1. Access the Experiments List
    • From the dashboard, take a look at the "Experiments" section to view all your created experiments.
  1. Select Experiment
    • Select the experiment from which you want to download data.
  1. Select Participants
    • Select the participants from which you want to download data.
  1. Download Data
    • Choose the preferred format (CSV, JSON, etc.).
    • In the Selected Data section, click on the "Download Data" button.

Uploading Experiment Data

Please continue to read Datahandler script for documentation on adding the datahandler script to your social web experiment. Go to Radcloud API for API documentation if you want to communicate with the Radcloud API directly from your own code.

Copying the API Key

  1. Go to the experiments section
    • Once logged in, navigate to the "Experiments" section. Lookup the experiment that you want to hold your participant data.
  1. Locate API Key
    • Find the column labeled "API Key".
  1. Copy API Key
    • Click the "Copy" icon button next to the experiment you want to use in your web experiment to copy it to your clipboard.

Deleting Participant Data

  1. Access the Experiment Details
    • From the dashboard, go to "Experiments" and select the experiment whose participant data you want to delete.
  1. Delete Participant Data
    • In the "Participants" section select the participant data you wish to delete.
    • Click the "Delete" button to remove the selected participant data.
  1. Deleting the Experiment
    • Ensure all participant data has been deleted before attempting to delete the experiment.
    • Once all participant data is removed, click the "Delete Experiment" trashcan button to delete the experiment.

Experiment Expiry

When an experiment reaches its two-year expiration date, the data will be automatically removed from the database. Prior to this, notifications will be sent to the experiment creator, supervisor, and any other linked Radboud accounts via email on three occasions: two weeks before the expiration, one week before, and on the expiration date itself. The default expiration is set to six months after the experiment's creation, but this can be extended up to two years. All notifications and actions will be logged in the RadCloud database for auditing purposes.

FAQs

  • Q: The lifetime of an experiment is two years, what will happen to my data when an experiment expires?
    • A: When an experiment reaches its two-year expiration date, the data will be automatically removed from the database. Notifications will be sent via email at three intervals before deletion.
  • Q: Can I use a Data Acquisition Collection in the Radboud Data Repository (RDR) via a web request using WebDAV?
    • A: Yes, but RadCloud offers advantages such as structured data storage and easier integration with participant-based experiments.
  • Q: What if I forget my login credentials?
    • A: You log in to Radcloud using your Radboud University account credentials (LDAP).
  • Q: Can I edit an experiment after creating it?
    • A: Yes, navigate to the "Experiments" section, select the experiment, and click on the "Edit" button to make changes.
  • Q: What data formats are available for download?
    • A: CSV and JSON formats are available for download.
  • Q: How do I copy my API key?
    • A: Go to your Experiment table, locate the API key column, and click the "Copy" button.
  • Q: How do I delete participant data?
    • A: In the experiment detail page, navigate to the "Participants" section, select the data to delete, and click the "Delete" button.
  • Q: Can I delete an experiment with participant data still present?
    • A: No, you must delete all participant data before you can delete the experiment.

Support

If you have any questions, suggestions, or feedback, please feel free to reach out to us via email at tsg@ru.nl. We are always open to improving this project based on your input.