Skip to content

Commit

Permalink
replace links to old docs site with current links (#416)
Browse files Browse the repository at this point in the history
  • Loading branch information
becky-gilbert authored Nov 21, 2024
1 parent e3ed2b7 commit 9e8b47f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion app/components/exp-player/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ export default Ember.Component.extend(FullScreen, {
var availableFrames = Ember.getOwner(this).lookup(`container-debug-adapter:main`).catalogEntriesByType('component')
.filter(componentName => componentName.includes('component') && componentName.includes('exp-') && !['components/exp-blank', 'components/exp-frame-base', 'components/exp-text-block', 'components/exp-player'].includes(componentName))
.map(componentName => componentName.replace('components/', ''));
console.error(`Unknown frame kind '${componentName}' specified. Check that 'kind' is specified for all frames and that it is always one of the following available frame kinds:\n\t${availableFrames.join('\n\t')}\nFrames are described in more detail https://lookit.github.io/ember-lookit-frameplayer/modules/frames.html. Frame kinds are all lowercase, like 'exp-lookit-exit-survey'. If you are trying to use a newer frame, you may need to update the frameplayer code for your study; see https://lookit.readthedocs.io/en/develop/researchers-update-code.html.`);
console.error(`Unknown frame kind '${componentName}' specified. Check that 'kind' is specified for all frames and that it is always one of the following available frame kinds:\n\t${availableFrames.join('\n\t')}\nFrames are described in more detail https://lookit.readthedocs.io/projects/frameplayer/en/latest/utils/protocol.html#study-protocol-structure. Frame kinds are all lowercase, like 'exp-lookit-exit-survey'. If you are trying to use a newer frame, you may need to update the frameplayer code for your study; see https://lookit.readthedocs.io/en/master/researchers-update-code.html.`);
}
return componentName;
}),
Expand Down
2 changes: 1 addition & 1 deletion app/randomizers/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ You have a variety of options for how to accomplish random condition assignment:
]
}

3. You can use the ``#RAND`` syntax and `frame parameters <https://lookit.github.io/lookit-frameplayer-docs/classes/Exp-frame-base.html#property_parameters>`_ to substitute in one of the two options for each condition:
3. You can use the ``#RAND`` syntax and :ref:`frame parameters <frame parameters>` to substitute in one of the two options for each condition:

::

Expand Down
10 changes: 6 additions & 4 deletions app/randomizers/random-parameter-set.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ use the ``random-parameter-set`` randomizer:

.. admonition:: Advanced options for choosing the parameterSet

You can `determine the weights based on the child's age <https://lookit.github.io/lookit-frameplayer-docs/classes/Random-parameter-set.html#property_parameterSetWeights>`_, to maintain balanced conditions.) You can also `keep kids in the same condition across all sessions they complete, or rotate them through conditions in order <https://lookit.github.io/lookit-frameplayer-docs/classes/Random-parameter-set.html#property_conditionForAdditionalSessions>`_.
You can :ref:`determine the weights based on the child's age<parameter-set-weights>` to maintain balanced conditions. You can also :ref:`keep kids in the same condition across all sessions they complete, or rotate them through conditions in order<condition-for-additional-sessions>`.


Examples
Expand Down Expand Up @@ -226,7 +226,7 @@ pairs):
Next, one of the two objects in ``parameterSets`` is selected randomly.
(By default, parameter sets are weighted equally, but
``parameterSetWeights`` can be provided as an optional key in the
``random-parameter-set`` frame. If provided, ``parameterSetWeights``
``random-parameter-set`` frame.) If provided, ``parameterSetWeights``
should be an array of relative weights for the parameter sets,
corresponding to the order they are listed. For instance, if we wanted
75% of participants to think about how tasty broccoli is, we could set
Expand Down Expand Up @@ -474,8 +474,9 @@ parameterSets [Array]

A single element of `parameterSets` will be applied to a given session.

conditionForAdditionalSessions [String | ``'random'``]
.. _condition-for-additional-sessions:

conditionForAdditionalSessions [String | ``'random'``]
[Optional] How to select a parameterSet for a participant who has previously
participated in this study. Must be one of ``'random'`` (default), ``'persist'``, or
``'rotate'``. Meanings:
Expand Down Expand Up @@ -513,8 +514,9 @@ conditionForAdditionalSessions [String | ``'random'``]
but then you changed ``parameterSets`` to have only 3 elements) and ``conditionForAdditionalSessions`` is
``"persist"``, then the participant is assigned to the last element of ``parameterSets``.

parameterSetWeights [Array]
.. _parameter-set-weights:

parameterSetWeights [Array]
[Optional] Array of weights for parameter sets; elements correspond to
elements of parameterSets. The probability of selecting an element
``parameterSets[i]`` is ``parameterSetWeights[i]/sum(parameterSetWeights)``.
Expand Down

0 comments on commit 9e8b47f

Please sign in to comment.