mad-lab-fau / carwatch-python Goto Github PK

instead of _ which results, for example, in "CARWatch_1", I'd recommend adding leading zeroes to the participant IDs (e.g., "CARWatch_001"). The number of leading zeroes should be chosen according to the total number of participants (1-99 => 2 digits, 100 - 999 => 3 digits) etc.

Maybe also check if the layout if adding leading zeroes would break things (also together with #2 )? otherwise, the participant IDs could also be in a separate line, between study name and saliva_id

At the moment, the only way to use the cli is to clone the repo and install it as developer.

However, in Python there is an easier way. You can register a script as a script entrypoint (https://python-poetry.org/docs/pyproject/#scripts)

This way, the script will be installed as global binary, when the package is installed.
I.e. after doing pip install carwatch you would be able to just call generate_labels from anywhere in the commandline.

Note, probably you should rename the script entrypoint to carwatch_generate_labels to avoid naming conflicts)

TODO: after new carwatch app is ready

• In our testcases the field "Enable manual scanning mode (allows to manually scan barcodes apart from being prompted by the CARWatch application)" is not working

• We can still scan barcodes without the app promting

• You can select the option in the app to enter barcode manully, mybe by NOT setting the checkbox this option shouldn´t be available

• check brand and version used below:
  carwatch_triass02_vp01_20231127.csv

"Should saliva IDs start at 0 or at 1 (i.e., S0 vs. S1)?" - [0/1]

so far, the saliva ids always have the prefix "S" (for saliva). it would be cool if this would also be configurable so that we can also generate labels or barcodes for other biomarkers, e.g., blood (=> prefix "B")

when using the options below, no newline between study name and saliva sample ID is printed in the labels:

Study name: DPL_Sleep
Duration of study [days]: 2
Number of saliva samples [per day]: 3
Read subject IDs from file? [y/n]: n
Number of participants: 30
Add prefix to participant number (e.g., 'VP_')? [y/n]: y
Subject prefix [VP_]: 
Evening salivette? [y/n]: n
Add study name and participant number to label? [y/n]: y
Add barcode to label? [y/n]: n
Output directory for labels [.]: 
Name of label file [barcodes]: barcodes_dpl_sleep
Use custom layout instead of Avery Zweckform J4791? [y/n]: n

the option could, for example, look like this:

Add prefix to participant number (e.g., "VP_") [default: None]:

Important: Check if this breaks the layout and/or if it's better to put the participant ID in a separate line?

• prefix is not displayed
• when prefix is set, zero padding is missing

• Could you transform the unix-timestamp to the actual date for the log file?
• Or add a seperate row that?
• Furthermore it´s not tracking the right timestamp:
  • actual time taken: 10:18 AM
  • log data: {"id":32768,"timestamp":1701078614298} which translates into 10:18 PM

Code + Example in README

• ask for number of samples per day excluding evening sample
• ask for additional evening sample

• Used https://mad-lab-fau.github.io/carwatch-web/ interface
• The generated barcodes didn´t have the same value as the one in the log data:
  • generated barcode e.g.: "0010128" which was the first label to scan
  • actual barcode in logs: "barcode_value":"0010100"

right now, it's the first option after being asked whether CARWatch should be used for study.
from the user's perspective, however, it would make more sense if this was the last option in the CLI (see also attached screenshot)