Change date format, column names and order for jasmine daily summaries#285
Change date format, column names and order for jasmine daily summaries#285MMel099 wants to merge 16 commits intoonnela-lab:developfrom
Conversation
|
Holding on this for now. |
|
Commit 8600d9a (Adjust Jasmine output column names and order) changes the column names and order to match the Jasmine output generated by the dashboard server's Forest tasks. IMPORTANT: If parameters.split_day_night is set to TRUE, a downstream collision will occur with the split_day_night_cols function due to the new column names. A future commit will be added to address this. |
|
An if statement check was added based on |
|
@GeorgeEfstathiadis could you have a look? I think you were the original author. |
|
@MMel099 I was able to trigger the test workflows but the checks are failing (https://github.com/onnela-lab/forest/actions/runs/15055312103/job/42319759802?pr=285). Please make sure all the checks are passing (for example, remove the commented out code; here's the Forest development guide for reference: https://forest.beiwe.org/en/latest/development.html) and then we will continue the review process. Thanks! |
|
I need a confirmation that these changes retain the current behavior as the default behavior, without changing output ordering and field names when run on a Beiwe server. (it can change, I just need to know.) |
|
Hi @hackdna and @biblicabeebli, Thanks for helping move this along! Ilya, I will look at these errors and push out a commit addressing them. Eli, these changes modify the column headers and order of the default forest jasmine output to mimic what is produced on the server. For example, the current Forest package produces a Jasmine field called I guess this is a good time to ask how the server uses the Forest package, and at what point do the headers/order get modified? Thanks! |
|
(aw crap I totally missed that response.) current
|
|
Also, the date should be in YYYY-MM-DD format which is an international standard. |
|
At the outset of this pull request, the goal was just to change the date and time conventions for the Jasmine summaries which had separate rows for date, hour, minute, etc. We later added the goal of fixing the discrepancy between the naming conventions of the local Forest script and those used to generate the dashboard summaries. Just realized that I should also check the other trees (Oak, Willow and possibly even Sycamore) for this discrepancy before rolling anything out.
Just out of curiousity about the next steps - who are the 3 consumers of this data that we would have to consult before making changes to the naming conventions? If we do proceed with these, what would be the best way of communicating changes - something like a 2 column csv with the old column names and the new ones? Lastly, I want to note that Eli advised me to use the YYYY-MM-DD format which I implemented (I should go back and edit my previous comments in this thread) |
|
Consumers - I'm speaking very generally here, a consumer is anyone who uses the platform that is a specific target audience for which there is a different kind of communication to be thought about. This time I came up with more. (It might seem ultra pedantic, but this is precisely the "the hardest problem in computer science is naming things correctly" Thing, if you've ever heard that.):
|
|
@MMel099 could you work on a new mapping dictionary for Eli? I think a simple table showing those fields (from all trees) whose headers are changing. @biblicabeebli I believe this is what we discussed recently and more or less what you need? @hackdna let's move forward with an initial release of Forest with the 3.12 upgrade. We can push another release once these new changes that @MMel099 is making (in conjuction with @biblicabeebli ) are ironed out. Please let me know if I'm misunderstanding anything. Thanks! |
|
@hydawo I will push on this issue over the weekend and attach that column mapping here |
|
I need a commit or forest release version to do the server side update. |
|
@hydawo @biblicabeebli @hackdna I have revised the branch to ensure that all github tests pass before merging. I'm also attaching a csv mapping with old and new column names with a few extra comments. Let me know if I should make any further changes or provide any other resources. Thank you! |
|
I was waiting for a go ahead from @biblicabeebli |
Previously, the Jasmine daily summaries have three separate columns for day, month and year. This pull request changes only the daily summary to have the format MM/DD/YYYY (EDIT: SINCE CHANGED TO YYYY-MM-DD)