Skip to content

Latest commit

 

History

History
69 lines (35 loc) · 4.5 KB

README.md

File metadata and controls

69 lines (35 loc) · 4.5 KB
Raw

lookit-stimuli-template

A template repository for Lookit researchers who want to host their stimuli on GitHub.

The instructions below are primarily intended for people with limited experience using GitHub or Git. If you are already comfortable using git via the command line or a desktop client and pushing your changes to GitHub, there is no need to use the GitHub web interface.

Getting started

  1. Log in to GitHub, making an account if you don't already have one.

  2. Click the "Fork" button at the top right of this page. This will copy the template stimuli repository to your own account.

  3. Edit the description (which will still be "A template repository for Lookit researchers who want to host their stimuli on GitHub") so it reflects the planned content of your repository.

Adding your stimuli

From your own fork, you can add stimuli right in GitHub like this:

  1. Click on the appropriate directory. For images, that's img. For audio and video files, the appropriate directory depends on their file format. For instance, mp4 files go in the mp4 directory.

  2. Click 'Upload files.' Drag and drop the files from your computer that you want to put online.

  3. Click 'Commit changes,' adding a brief message explaining what you added or changed for posterity.

By keeping the various file types in their own directories, and using the same filenames for equivalent files (like an mp4 and webm version of the same video), you will be ready to make use

What if I want more directories, or sub-directories within these?

That's most straightforward to do using the command line or a desktop client for GitHub, like GitHub Desktop or Sourcetree. However, you can also do it right in Github by clicking 'Create new file' instead of 'Upload files' from the place where you want to add a new directory. Then, in the box to type the file name, type NewDirectoryName/README.md, replacing NewDirectoryName with your desired directory name. This will create the new directory and a README.md file inside it. Then you can add other files too.

Accessing your stimuli and telling Lookit where to find them

You have two options:

1. Use the latest version

If you always want to point to the latest version of your stimuli, you can access those at

https://raw.githubusercontent.com/YOUR_USERNAME/lookit-stimuli-template/master/DIRECTORY/FILENAME.EXT

For instance, if your GitHub username is kimberscott, and you have a cats.jpg file in the img directory, you could link to it at

https://raw.githubusercontent.com/kimberscott/lookit-stimuli-template/master/img/cats.jpg

Most Lookit frames allow you to specify a baseDir or base directory for your files, and then only provide filenames instead of full paths. You can learn more about that in the docs. In this case, your baseDir would be:

https://raw.githubusercontent.com/YOUR_USERNAME/lookit-stimuli-template/master/

This option has the advantage that if you make slight adjustments to your stimuli, you don't also have to update your study to use the new versions. However, if you delete any files or make other unexpected changes, it may break something in your study.

2. Use a specific version

If you want to point to a specific, fixed version of your stimuli - a 'snapshot in time' - you can select a particular "commit" to point to. From your fork of this repository, click the "N commits" at the top to view a list of commits. Click the "clipboard" icon next to the commit you want to use. This copies the COMMIT_ID.

The URLs for the stimuli as they were at the time of this commit are:

https://raw.githubusercontent.com/YOUR_USERNAME/lookit-stimuli-template/COMMIT_ID/DIRECTORY/FILENAME.EXT

And the baseDir to use is:

https://raw.githubusercontent.com/YOUR_USERNAME/lookit-stimuli-template/COMMIT_ID/

Making changes to your stimuli

Deleting files: You can delete individual files by navigating to them in GitHub and then clicking the "trash" icon. You'll be prompted to commit this change.

Changing files: You can upload new versions of your files in the same directory where the old ones are to replace them.

Each time you delete a file or upload a new file, you will need to commit the change and can write a short message about what you changed and why. Your commit history then shows a complete record of the changes you've made over time, which is very helpful for your future self.