00290: metadata reorganization #2
Conversation
formatting code blocks and adding Compatibility issues
Formatting code blocks properly.
ethanjli
changed the title
There was a problem hiding this comment.
I went through the design document and made formatting/grammar edits where I was confident that I understood what you meant, and I've left some follow-up comments about specific places where I wasn't sure what you meant. After you address my comments with replies, then I'm happy to edit the design document and mark my comments as resolved.
Once we mark all comments as resolved, I think we are ready to merge this PR. In #290 I will raise some concerns about the proposed design, which I'd like for us to discuss and (if necessary) address with future edits to this design document in another PR.
|
|
||
| - Organize metadata fields between the configuration files in a more logical way which makes it easier to find specific fields. | ||
| - Make it easy for a user to share their `config.json` file, so that they can make their Planktoscope settings available for reuse on other machines or by other users, but without sharing any personal information or hardware-specific information (e.g. machine serial number). | ||
| - Have a more precise `hardware.json` file for debugging and for holding all information about a specific machine (e.g. which will be useful for FairScope). |
There was a problem hiding this comment.
This line originally said "have all the information about a specific machine for Fairscope use", but I'm not sure what you meant by that. I changed that text to "all information about a specific machine (e.g. which will be useful for FairScope)", but I'm still not sure what you specifically mean. Can you explain a bit more?
| - Organize metadata fields between the configuration files in a more logical way which makes it easier to find specific fields. | ||
| - Make it easy for a user to share their `config.json` file, so that they can make their Planktoscope settings available for reuse on other machines or by other users, but without sharing any personal information or hardware-specific information (e.g. machine serial number). | ||
| - Have a more precise `hardware.json` file for debugging and for holding all information about a specific machine (e.g. which will be useful for FairScope). | ||
| - Create a `personal_info.json` file which eventually could be encrypted and used to commit modifications to the machine, upload datasets to Ecotaxa, or provide other other user-oriented features in the future. |
There was a problem hiding this comment.
commit modifications to the machine
Can you explain what you meant by this?
| - Make it easy for a user to share their `config.json` file, so that they can make their Planktoscope settings available for reuse on other machines or by other users, but without sharing any personal information or hardware-specific information (e.g. machine serial number). | ||
| - Have a more precise `hardware.json` file for debugging and for holding all information about a specific machine (e.g. which will be useful for FairScope). | ||
| - Create a `personal_info.json` file which eventually could be encrypted and used to commit modifications to the machine, upload datasets to Ecotaxa, or provide other user-oriented features in the future. | ||
| - Improve data quality by adding more relevant scientific variables to the metadata. |
There was a problem hiding this comment.
Can you provide one or two examples of scientific variables which this proposal will add to the metadata in order to improve the quality of the data?
| - Organize metadata fields between the configuration files in a more logical way which makes it easier to find specific fields. | ||
| - Make it easy for a user to share their `config.json` file, so that they can make their Planktoscope settings available for reuse on other machines or by other users, but without sharing any personal information or hardware-specific information (e.g. machine serial number). | ||
| - Have a more precise `hardware.json` file for debugging and for holding all information about a specific machine (e.g. which will be useful for FairScope). | ||
| - Create a `personal_info.json` file which eventually could be encrypted and used to commit modifications to the machine, upload datasets to Ecotaxa, or provide other user-oriented features in the future. |
There was a problem hiding this comment.
commit modifications to the machine
I'm not sure what you meant by this - can you explain a bit more?
| } | ||
| ``` | ||
| - The `config.json` file should only store acquisition settings and camera settings selected by the user via the GUI. | ||
| Exchanging this file should assure a comparable result. |
There was a problem hiding this comment.
Exchanging this file should assure a comparable result.
I'm not sure what you mean by this (exchanging the file with whom/what? What should the result be comparable to?). Can you explain a bit more?
| } | ||
| ``` | ||
| - The `personal_info.json` file should store information entered by the user (via the GUI) about the identity of the user/team, information about the mission where the PlanktoScope is being deployed, and Ecotaxa login credentials for the PlanktoScope software to interact with the Ecotaxa API (especially for exporting data directly to EcoTaxa). | ||
| This file could be shared between team members using Planktoscopes for the same mission, to assure that an identical protocol/equipment used information. |
There was a problem hiding this comment.
This line originally said "to assure an identical protocol/equipment used information", but I'm not sure what that means. Can you explain a bit more?
ethanjli
changed the title
formatting code blocks and adding Compatibility issues
For PlanktoScope/PlanktoScope#290