Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CHS/Lookit terms and add jsPsych experiment runner #437

Merged
merged 23 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
3c16211
first pass at adding jsPsych experiment runner, clarifying CHS vs Loo…
becky-gilbert Nov 4, 2024
9c3e2c6
move tutorial pages into separate lookit tutorial section
becky-gilbert Nov 5, 2024
4b2f481
add jsPsych tutorial pages nested in tutorial step 3
becky-gilbert Nov 7, 2024
ee7fa3d
add target label and update tutorial step number
becky-gilbert Nov 7, 2024
3326150
add new tutorial step 3 create study section for nesting lookit and j…
becky-gilbert Nov 7, 2024
19fbb88
add target and update tutorial step number
becky-gilbert Nov 7, 2024
c3816b6
update tutorial step number
becky-gilbert Nov 7, 2024
68b9d28
add new edit study design page to correspond with our now-split study…
becky-gilbert Nov 7, 2024
7d38884
update home page and TOC with CHS vs Lookit terms and to add jsPsych …
becky-gilbert Nov 7, 2024
4bc0582
update TOC with new create study step and nested lookit/jspsych tutor…
becky-gilbert Nov 7, 2024
230a9ac
move study fields page from Lookit into Using CHS since these apply t…
becky-gilbert Nov 7, 2024
a59ea8b
remove fields that are specific to study type (now in on the study de…
becky-gilbert Nov 7, 2024
836a420
update lookit-api installation page with jsPsych and EFP RecordRTC info
becky-gilbert Nov 7, 2024
a3ab316
update CHS vs Lookit terms, update URLs, split Study Edit section int…
becky-gilbert Nov 7, 2024
0ac5df0
update CHS vs Lookit terms, CHS URLs, add jsPsych study type and link…
becky-gilbert Nov 7, 2024
2496344
update CHS vs Lookit terms, CHS links, add jsPsych experiment runner,…
becky-gilbert Nov 7, 2024
9a49804
update with CHS vs Lookit terms, and add jsPsych to architecture over…
becky-gilbert Nov 7, 2024
7062e35
fix typo
becky-gilbert Nov 7, 2024
213b004
Update README.md
mekline Nov 8, 2024
add7820
Update community-irb-and-legal-information.rst
mekline Nov 8, 2024
a2e4a8c
Update faq.rst
mekline Nov 8, 2024
416f2de
fix typos and grammar errors
becky-gilbert Nov 8, 2024
38557e8
remove references to pages that do not exist (moved to separate PR)
becky-gilbert Nov 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# lookit-docs

Documentation for Lookit project, including use of platform and lookit-api and ember-lookit-frameplayer repos.
Documentation for Children Helping Science (aka "Lookit") project, including use of the CHS platform, the internal Lookit and jsPsych experiment runners, and associated repositories.

Lookit platform: https://lookit.readthedocs.io/en/develop/
CHS platform: https://lookit.readthedocs.io/en/develop/

Ember Lookit Frameplayer (experiment runner): https://lookit.readthedocs.io/projects/frameplayer/en/latest/
Experiment runners:

Lookit (Ember Lookit Frameplayer): https://lookit.readthedocs.io/projects/frameplayer/en/latest/

jsPsych: https://lookit.readthedocs.io/projects/chs-jspsych/en/latest/

---

## Contributing

Have you spotted an error in the documentation, or have other suggestions for improvement? We'd love your contributions! If you're not sure whether we'll want to incorporate your changes, please open an Issue in this repository so that we can discuss it first.

If you are not part of the Lookit team and would like to contribute changes to the Lookit documentation, you will follow the same Installation and Editing steps listed below except that you will *make changes on your own fork of this repository*. Here is a summary of the process:
If you are not part of the CHS/Lookit team and would like to contribute changes to the documentation, you will follow the same Installation and Editing steps listed below except that you will *make changes on your own fork of this repository*. Here is a summary of the process:
1. Fork this repository.
2. Set up your local environment, following the Installation steps below.
3. Make your changes, commit them, and push to your fork/branch.
Expand Down Expand Up @@ -298,8 +302,8 @@ Below are references for embedded/reusable links and footnotes (see https://gith
[sphinx-rst]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

[^forkfootnote]:
If you are not part of the core Lookit team then you should *fork this repository* first (fork button in upper-right corner of this page), then clone your fork:
If you are not part of the core CHS/Lookit team then you should *fork this repository* first (fork button in upper-right corner of this page), then clone your fork:
```
/ $ git clone https://github.com/<your-username>/lookit-docs.git
/ $ cd lookit-docs
```
```
44 changes: 22 additions & 22 deletions docs/source/community-involvement.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Community involvement
================================================

Currently Lookit is run by three people working at home during a
Currently the Children Helping Science (CHS) project is run by three people working at home during a
pandemic. We had a description here of all the things we do, but really,
enough said.

Ways *all* Lookit researchers contribute
Ways *all* CHS researchers contribute
----------------------------------------

1. Peer-to-peer support
Expand All @@ -18,27 +18,27 @@ that were confusing!
2. Provide peer feedback on studies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Before submitting a study to Lookit, researchers gather peer feedback
Before submitting a study to CHS, researchers gather peer feedback
(see :ref:`Study approval process <study_approval>`).
This is a quick and lightweight process, not scientific peer review, but
it does a lot to improve the participant experience! As a researcher on
Lookit, you will help to review other studies as well as posting your
CHS, you will help to review other studies as well as posting your
own for feedback.

3. Recruitment
~~~~~~~~~~~~~~

Once you start running your study, you will need to actively recruit
participants. There’s a shared Lookit participant pool, but we need
participants. There’s a shared CHS participant pool, but we need
everyone’s combined efforts to build it.

If you have programming experience (or employ someone who does)
---------------------------------------------------------------

Lookit is an open-source project, but struggles with the problem that relatively few of
CHS is an open-source project, but struggles with the problem that relatively few of
its primary stakeholders (developmental researchers) feel equipped to contribute to
feature development. If you have experience programming in Python, the most helpful way
to contribute is to :ref:`Set up for local development <Local dev setup>` on the Lookit codebase, take
to contribute is to :ref:`Set up for local development <Local dev setup>` on the CHS codebase, take
ownership of an issue in the lookit-api repo and make a PR with your implementation
(and your unit tests ;) ).

Expand All @@ -65,9 +65,9 @@ The existence of the Working Groups has many advantages, including:
and only by those who (e.g.,) happen to be paying attention to a general
email listserv at that time.

Anyone involved with a current study on Lookit, or who is developing
Anyone involved with a current study on CHS, or who is developing
one, is very welcome to join a Working Group! We also have an
expectation that **any research team hosting a study on Lookit will have
expectation that **any research team hosting a study on CHS will have
at least one member who is a member of at least one Working Group**,
with a flexible time commitment of about 2 hours/week. The person
meeting this requirement for their research group should be a “main”
Expand All @@ -80,7 +80,7 @@ Here are the current working groups:
Best Practices for Video Chat Studies
--------------------------------------------------------------------------------

The goal of this Working Group is to develop best practices (and, rarely, rules) about running video chat studies (also called "synchronous" studies, these are typically "Zoom" studies). Over the past couple of years, there have been many groups independently identifying great ways to do video chat studies, and we hope to discuss and iterate on what a diverse group of researchers have done. As we develop resources for best practices, members of Lookit (and others) may choose to follow them because they are ideas that have been refined over time by a large and diverse group of people, and also just because consistency can be inherently valuable (e.g., even if a practice is not inherently better than some alternative, being consistent with our participants can make things easier and more predictable for them). See a draft of some ideas `here <https://docs.google.com/document/d/1t5MY6tfA_o9MVGSBa0j_2hXfDRpRq5mSLnoayUjBLUA/edit?usp=sharing>`_.
The goal of this Working Group is to develop best practices (and, rarely, rules) about running video chat studies (also called "synchronous" studies, these are typically "Zoom" studies). Over the past couple of years, there have been many groups independently identifying great ways to do video chat studies, and we hope to discuss and iterate on what a diverse group of researchers have done. As we develop resources for best practices, members of CHS (and others) may choose to follow them because they are ideas that have been refined over time by a large and diverse group of people, and also just because consistency can be inherently valuable (e.g., even if a practice is not inherently better than some alternative, being consistent with our participants can make things easier and more predictable for them). See a draft of some ideas `here <https://docs.google.com/document/d/1t5MY6tfA_o9MVGSBa0j_2hXfDRpRq5mSLnoayUjBLUA/edit?usp=sharing>`_.

Recruitment (social media, etc.)
--------------------------------------------------------------------------------
Expand All @@ -98,25 +98,25 @@ Eliciting and organizing feature feedback from researchers

The goal of this Working Group is to gather information from researchers
in multiple ways (e.g., surveys, focus groups, monitoring of questions
on Slack and GitHub issues) about potential new features for Lookit, and
on Slack and GitHub issues) about potential new features for CHS, and
work towards prioritizing them. This requires synthesizing information
about what would best benefit researchers and what is easiest for the
programmers to implement, and so this group will work with the
programmers as well.

Advise and support new Lookit researchers (“Researcher onboarding”)
Advise and support new CHS researchers (“Researcher onboarding”)
--------------------------------------------------------------------------------

The goal of this Working Group is to help new researchers who are
designing their first Lookit study. This can involve creating additional
designing their first CHS study. This can involve creating additional
tutorials/samples/documentation, providing 1-on-1 mentoring, and
monitoring a Slack channel where new researchers ask questions.

Parent-facing “first 10 minutes”
--------------------------------------------------------------------------------

The goal of this Working Group is to maximize the parent-facing
experience, from finding Lookit to finishing the consent for the child’s
experience, from finding CHS to finishing the consent for the child’s
first study. Example work might include revising the homepage and doing
focus group (user experience) studies of naive parents navigating it,
creating informational videos about what participation entails and
Expand All @@ -138,27 +138,27 @@ Researcher-facing “first 10 minutes”
--------------------------------------------------------------------------------

The goal of this Working Group is to maximize the researcher-facing
experience, from discovering Lookit to deciding whether or not it might
experience, from discovering CHS to deciding whether or not it might
be a good fit for their research. For example, this group might create a
webpage that is directed towards PIs, to determine in 3-5 minutes
whether joining Lookit might be a good use of a graduate student’s time.
whether joining CHS might be a good use of a graduate student’s time.
Another webpage might be directed towards graduate students, to get a
sense of the types of research Lookit is a good fit for, and what types
of skills would be necessary to conduct that research via Lookit. Much
sense of the types of research CHS is a good fit for, and what types
of skills would be necessary to conduct that research via CHS. Much
of this information already exists, but optimizing it for different
audiences could make a big difference in the uptake of Lookit by
audiences could make a big difference in the uptake of CHS by
research teams.

The A-Team
--------------------------------------------------------------------------------

Named after a TV show about mercenaries for hire: “If you have a
problem, if no one else can help, and if you can find them, maybe you
can hire… the A-Team.” For Lookit, this Working Group will work on all
can hire… the A-Team.” For CHS, this Working Group will work on all
of the miscellaneous tasks that are shorter term (so they don’t have
their own working group) but totally essential for the development of
Lookit. Maybe a couple of weeks working on legal and ethical issues to
build a knowledge base for getting Lookit access agreement signed. And
CHS. Maybe a couple of weeks working on legal and ethical issues to
build a knowledge base for getting CHS access agreement signed. And
then the next project might be exploring non-monetary compensation for
families (certificates? personalized information?). All skill sets
welcome for a well-balanced group of problem solvers.
Expand Down
Loading