Researcher Documentation #32
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
bleonar5
reviewed
Jun 4, 2024
becky-gilbert
approved these changes
Jun 5, 2024
There was a problem hiding this comment.
This looks fantastic! Great work!!
I think we’ll want to make some changes down the line, but if so it will probably be just expanding on what you have rather than doing any major restructuring.
The only other thing I noticed is that some of the docs are a little bit more relevant to developers, i.e. why we included things like the data package and what's happening under the hood. So we could consider trying to pull those things apart into separate sections/pages, so that researchers aren't confused by things that may not be relevant to them. But I don't feel strongly about this and would welcome opinions from others.
Anyway, if you're open to the possibility of making further changes later on, then I’m very happy for this to be merged now 🚀
|
I agree with a lot of what you wrote. I accidentally wrote the docs from my, a developer, perspective, but I agree these docs NEED to be for researchers. Any notes for developers will need to go somewhere else. |
okaycj
added a commit
that referenced
this pull request
Jul 23, 2024
* Rebase fixes * Fix a few mistakes found from rebasing * init video package * Add s3 from EFP * Update eslint config * Update packages * Add s3 class * Add empty test to video * Fix deepfreeze import * Fix test * Jsdoc Comments (#26) * Update eslint package to fix warning message * Add exit survey pacakge * exit survey * se survey_function to format survey text * edit exit survey question titles and descriptions * change question names and MC values to match EFP names * add withdrawal and feedback questions * Change package name, exit survey parameters * Added privacy and databrary params * Get study to add to withdraw copu * disable the video sharing questions if video withdrawal is true * Add MD link * Add global data store * fix withdrawal question value in data and logic for enabling/disabling the other video-related questions * add validation for child birthdate: cannot be a future date * Update root package * Update survey to use new data structure * First pass at tests * Add data finish function * Update tests * Update versions of deps * freeze loaded data * Add s3 from EFP * Add s3 class * Update linters to support jsdoc comments * First pass at code documentation * Change functions to arrow functions * Fix tests * fix typos * minor edits to JSdoc comments * Format and comment changes * Test updates * Moved user function to run first * A few rebase errors --------- Co-authored-by: Becky Gilbert <[email protected]> * Another Video PR (#27) * Update eslint package to fix warning message * Add exit survey pacakge * exit survey * Use survey_function to format survey text * edit exit survey question titles and descriptions * change question names and MC values to match EFP names * add withdrawal and feedback questions * Change package name, exit survey parameters * Added privacy and databrary params * Get study to add to withdraw copu * disable the video sharing questions if video withdrawal is true * Add MD link * Add global data store * fix withdrawal question value in data and logic for enabling/disabling the other video-related questions * add validation for child birthdate: cannot be a future date * Update root package * First pass at tests * Add data finish function * Update tests * Update versions of deps * freeze loaded data * Add s3 from EFP * Add s3 class * First pass at code documentation * add auto bind dependency * Add trial recorder * Session recording * More package updates * Add comments to code --------- Co-authored-by: Becky Gilbert <[email protected]> * Change package name to record * Monorepo jest config function * Update tsconfig to extend correct jspsych resource * Update package jest config * Update install instructions * Add support environment file in data package * fix formatting * Update rollup config This commit will do two things. First, this will only bundle iife configs. Second, it adds the data package as an external dependency. * Researcher Documentation (#32) * Set up mkdocs * Add markdown files * move to mocros plugin * Format changes * Finish parameters table for surveys * Add strict to build * Add validation, git repo url, and exclude docs to config * Link to change log wasn't working * Grammar mistake in record docs * Add AWS S3 upload to Record extension (#29) * Rebase fixes * Fix a few mistakes found from rebasing * adapt EFP S3 class for AWS SDK v3 * rename S3 class/file to LookitS3 * add AWS S3 region to Env type * import S3 class into Recorder and add S3 upload (keep local download option for now) * move creation of Recorder instance from trial constructor to on_start * set strictPropertyInitialization:false to give the Recorder an s3 property that is not always set in constructor (can remove this if we remove local download option) * fix formatting error * call jsPsych finishTrial in stop plugin, give the recorder a second to stop before finishing * add optional filename param to Recorder constructor and util to create filename * remove strictPropertyInitialization: false * mark vars as optional so that they do not need to be defined in constructor * make s3 optional so that it does not need to be definitely assigned in constructor * remove the getFilename util and replace with class create filename method and filename getter * store recorder instance on window, call stop on that existing recorder, and throw errors based on existence/absence of recorder * S3 tests * fix file path for recorder import * make the recorder stop method async and have stop plugin wait for upload to finish * Change type of sessionRecorder to "unknown" To facilitate the typing for our window storage, I've added an interface that extends Window. Additionally, there's a new script in the root of this repo that will clean out "dist" directories. * fix JSDoc and linting errors * formatting fix * Fix broken tests after data went external * Remove prettier ignore file * Add typing for env values and update how s3 uses them * Add local down env value to record --------- Co-authored-by: CJ Green <[email protected]> * Update record tests * Fixed tests for node v18 * Fixed typos --------- Co-authored-by: Becky Gilbert <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR provides documentation for researchers to aid in their study design.
Implementation
Each package has a README.md file in its root. This will be used for the
readthedocssite as well as the default view on the package's npmjs page.To install and run development server:
TODO