-
Notifications
You must be signed in to change notification settings - Fork 8
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
BREAKING CHANGE: Update data paths #476
Merged
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
This was
linked to
issues
May 15, 2024
Visit the preview URL for this PR (updated for commit 5caa0b7): https://ccv-honeycomb--pr476-ref-paths-2eyroq5u.web.app (expires Thu, 23 May 2024 19:22:15 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 4ace1dcea913a952d2a1af84b94a4421bf36e610 |
broarr
approved these changes
May 16, 2024
RobertGemmaJr
commented
May 16, 2024
RobertGemmaJr
commented
May 16, 2024
RobertGemmaJr
commented
May 16, 2024
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.
Folder Structure
The big change here is how we're nesting the folders. The file follows the following structure:
/data/
mode
/studyID
/participantID
/start_date
.jsondevelopment
orproduction
That structure is nested inside userData while the participant is running through the experiment and then is copied into an output folder (Desktop/getName) when the participant finishes the experiment.
data
is used to separate the output data from the experiment from any other data that may be included. I don't really have anything in mind but have noticed Honeycomb users tend to have other information (matlab scripts, papers, etc) in the folder. I likedata
as a better delineator here rather than jumping straight intostudyID
mode
is used to further delineate production data from data that was created during development. Most users have a separate lab computer for the production data so it's not much of a change but is definitely helpful for me. Plus we basically get it for free now that we're using Vite!User data
I was looking to move the "running" file save to the
temp
folder but everything I've been reading online points to saving the data inuserData
like it was. This way the data will stay there permanently.Note that the really important quirk of
userData
is the fact that is saves partial run-throughs of the experiment. If a participant begins the experiment but quits the app before completing it (including app errors/crashes) the data will still be saved inuserdata
it just won't be copied over to the desktop. I think it's best to leave it asuserData
so that those partial run-throughs will be saved permanently, just hidden away.Output
Maintains that the data file(s) are created on the desktop at the end of the file. The file is copied from
userData
. Eventually I'd like for this path to be customizable but that's not a super pressing feature, the lab can change it with a single line of code if the really need