forked from barrettfdavis/online_actogram
-
Notifications
You must be signed in to change notification settings - Fork 3
Discrepancies between documented and actual command line options #14
Open
Description
There are discrepancies between the command line options documented in the readme and the ones that actually exist in the code.
The documentation:
Lines 97 to 109 in 2699eb7
--freq determines the granularity of binned online/offline periods (default is 15 minutes increments, ex. --freq '15T')
--start_date sets initial date to plot from, default is 180 days ago (ex. --start_date '2022-01-01')
--daily_blur applies median filtering between days (off by default, ex. --daily_blur 3)
--period_blur applies median filtering between binned time periods (off by default, ex. --period_blur 5)
--normalize normalizes search frequency against max, then applies binary mask (plot shows periods of some search history vs. none, on by default)
--dims sets the relative dimensions of generated actogram plot (ex. --dims (4, 6))
--printer_friendly sets whether activity is shown in black on white (friendly) or vice versa (False by default, ex. --printer_friendly True)
The code:
webactogram/src/webactogram/webactogram.py
Lines 802 to 816 in 2699eb7
parser.add_argument('--freq', type=str, action='store', default='15T', help='Frequency of the actogram. Default is 15T (15 minutes).')
parser.add_argument('--start', type=str, action='store', default='2021-08-01', help='Start date of the actogram. Default is 2021年08月01日.')
parser.add_argument('--end', type=str, action='store', default=None, help='End date of the actogram. Default is None (today).')
parser.add_argument('--hourly_blur', type=int, action='store', default=False, help='Hourly blur of the actogram. Default is 0 (no blur).')
parser.add_argument('--daily_blur', type=int, action='store', default=False, help='Daily blur of the actogram. Default is 0 (no blur).')
parser.add_argument('--normalize', type=int, action='store', default=True, help='Normalize the actogram. Default is True (normalize).')
parser.add_argument('--png', action='store_true', default=True, help='Save the actogram as a png. Default is True (save).')
parser.add_argument('--csv', action='store_true', default=True, help='Save the actogram as a csv. Default is True (save).')
parser.add_argument('--show', action='store_true', default=True, help='Show the actogram in a window just after generation. Default is True (show).')
parser.add_argument('--printer_friendly', action='store_true', default=False, help='Printer friendly actogram (black and white). Default is False (no).')
parser.add_argument('--landscape', action='store_true', default=True, help='Orientation of the plot: True is horizontal, False is vertical. Default is True (horizontal).')
parser.add_argument('--legacy', action='store_true', default=False, help='Use old internal method to import browser histories data. If false, will use browser-history external module (more browsers supported and all profiles are imported). Default: False (no).')
The discrepancies:
--startoption in code is referred to as--start_datein docs--endoption in code isn't in docs--period_bluroption in docs isn't in code--dimsoption in docs isn't in code--pngoption in code isn't in docs--csvoption in code isn't in docs--showoption in code isn't in docs--landscapeoption in code isn't in docs--legacyoption in code isn't in docs
Metadata
Metadata
Assignees
Labels
No labels
Type
Fields
Give feedbackNo fields configured for issues without a type.