.. _data-analysis: Data Analysis ************* Each data you send and all the related information (the way the data has been built, the feedback from the target, and so on) are stored within the ``fuddly`` database (an SQLite database located at ``/fmkdb.db``). They all get a unique ID, starting from 1 and increasing by 1 each time a data is sent. FmkDB Toolkit ============= To interact with the database a convenient toolkit is provided (``/tools/fmkdb.py``). The preferred way of running tool is through the fuddly cli, but they should also work by being called directly, though it is not guaranteed. Usage Examples -------------- Let's say you want to look at all the information that have been recorded for one of the data you sent, with the ID 4. The following command will display a synthesis of what you want:: fuddly tool fmkdb -i 4 And if you want to get all information, issue the following:: fuddly tool fmkdb -i 4 --with-data --with-fbk You can also request information on all data sent between two dates. For instance the following command will display all data information that have been recorded between 25th January 2016 (11:30) and 26th January 2016:: fuddly tool fmkdb --info-by-date 2016/01/25-11:30 2016/01/26 For further information refer to the help by issuing:: fuddly tool fmkdb -h Fmkdb Toolkit Manual -------------------- Hereunder is shown the output of ``fuddly tool fmkdb -h``. .. code-block:: none usage: fmkdb [-h] [--fmkdb PATH] [--no-color] [-v] [--page-width WIDTH] [--fbk-src FEEDBACK_SOURCES] [--project PROJECT_NAME] [--fbk-status-formula STATUS_REF] [-s] [-i DATA_ID] [--info-by-date START END] [-ids FIRST_DATA_ID LAST_DATA_ID] [-wf] [-wd] [-wa] [--without-fmkinfo] [--without-analysis] [--limit LIMIT] [--raw] [-dd] [-df] [--data-atom ATOM_NAME] [--fbk-atom ATOM_NAME] [--force-fbk-decoder DATA_MODEL_NAME] [--export-data FIRST_DATA_ID LAST_DATA_ID] [-e DATA_ID] [--remove-data FIRST_DATA_ID LAST_DATA_ID] [-r DATA_ID] [--data-with-impact] [--data-with-impact-raw] [--data-without-fbk] [--data-with-specific-fbk FEEDBACK_REGEXP] [-a IMPACT COMMENT] [--disprove-impact FIRST_ID LAST_ID] Arguments for FmkDB toolkit script options: -h, --help show this help message and exit Miscellaneous Options: --fmkdb PATH Path to an alternative fmkDB.db --no-color Do not use colors -v, --verbose Verbose mode --page-width WIDTH Width hint for displaying information Configuration Handles: --fbk-src FEEDBACK_SOURCES Restrict the feedback sources to consider (through a regexp). Supported by: --data-with-impact, --data-without-fbk, --data- with-specific-fbk --project PROJECT_NAME Restrict the data to be displayed to a specific project. Supported by: --info-by-date, --info-by-ids, --data-with- impact, --data-without-fbk, --data-with-specific-fbk --fbk-status-formula STATUS_REF Restrict the data to be displayed to specific feedback status. This option provides the formula to be used for feedback status filtering (the character "?" should be used in place of the status value that will be checked). Supported by: --data-with- impact Fuddly Database Visualization: -s, --all-stats Show all statistics Fuddly Database Information: -i, --data-id DATA_ID Provide the data ID on which actions will be performed. Without any other parameters the default action is to display information on the specified data ID. --info-by-date START END Display information on data sent between START and END (date format 'Year/Month/Day' or 'Year/Month/Day-Hour' or 'Year/Month/Day-Hour:Minute') -ids, --info-by-ids FIRST_DATA_ID LAST_DATA_ID Display information on all the data included within the specified data ID range -wf, --with-fbk Display full feedback (expect --data-id) -wd, --with-data Display data content (expect --data-id) -wa, --with-async-data Display any related async data (expect --data-id) --without-fmkinfo Do not display fmkinfo (expect --data-id) --without-analysis Do not display user analysis (expect --data-id) --limit LIMIT Limit the size of what is displayed from the sent data and the retrieved feedback (expect --with-data or --with-fbk). --raw Display data and feedback in raw format Fuddly Decoding: -dd, --decode-data Decode sent data based on the data model used for the selected data ID or the atome name provided by --atom -df, --decode-fbk Decode feedback based on the data model used for the selected data ID or the atome name provided by --fbk-atom --data-atom ATOM_NAME Atom of the data model to be used for decoding the sent data. If not provided, the name of the sent data will be used. --fbk-atom ATOM_NAME Atom of the data model to be used for decoding feedback. If not provided, the default data model decoder will be used (if one exists), or the name of the first registered atom in the data model --force-fbk-decoder DATA_MODEL_NAME Decode feedback with the decoder of the data model specified Fuddly Database Operations: --export-data FIRST_DATA_ID LAST_DATA_ID Extract data from provided data ID range -e, --export-one-data DATA_ID Extract data from the provided data ID --remove-data FIRST_DATA_ID LAST_DATA_ID Remove data from provided data ID range and all related information from fmkDB -r, --remove-one-data DATA_ID Remove data ID and all related information from fmkDB Fuddly Database Analysis: --data-with-impact Retrieve data that negatively impacted a target. Analysis is performed based on feedback status and user analysis if present --data-with-impact-raw Retrieve data that negatively impacted a target. Analysis is performed based on feedback status --data-without-fbk Retrieve data without feedback --data-with-specific-fbk FEEDBACK_REGEXP Retrieve data with specific feedback provided as a regexp -a, --add-analysis IMPACT COMMENT Add an impact analysis to a specific data ID (expect --data- id). IMPACT should be either 0 (no impact) or 1 (impact), and COMMENT provide information --disprove-impact FIRST_ID LAST_ID Disprove the impact of a group of data present in the outcomes of '--data-with-impact-raw'. The group is determined by providing the smaller data ID (FIRST_ID) and the bigger data ID (LAST_ID). Plotty ====== Plotty is a tool used to visualize data from the fmkDB. To interact with the database a convenient toolkit is provided (``/tools/plotty/*``). Similarly to ``fmkdb`` you can run it through the fuddly cli if fuddly has been installed (through a package manager or in a venv). If not you can run it from the command line directly. Usage Examples -------------- A very common usage is just to plot the data relatively to the date it was sent at. To do that, you can use the plotty CLI, at ``/tools/plotty/plotty.py``:: fuddly tool plotty -ids '0..100|2' Plots the SEND_DATE in function of the ID of every message which has en even ID between 0 and 100. A lot of display and formatting options are available to build your own plotting experience ♥‿♥ For further information refer to the help by issuing:: fuddly tool plotty -h Plotty Manual ------------- Hereunder is shown the output of ``fuddly tool plotty -h`` .. code-block:: none usage: plotty [-h] -ids DATA_IDS [-df DATE_FORMAT] [-db PATH [PATH ...]] [-f FORMULA] [-poi POINTS_OF_INTEREST] [-gm {all,poi,auto}] [-hp] [-l ANNOTATIONS [ANNOTATIONS ...]] [-al ASYNC_ANNOTATIONS [ASYNC_ANNOTATIONS ...]] [-o OTHER_DATA_IDS] [-s VERTICAL_SHIFT] Arguments for Plotty options: -h, --help show this help message and exit Main parameters: -ids, --data_ids DATA_IDS The data ids to take into account should be: either ..[|], or ..[|], ..., ..[|] -df, --date-format DATE_FORMAT Wanted date format, in a strftime format (1989 C standard). Default is %H:%M:%S.%f -db, --fmkdb PATH [PATH ...] Path to any fmkDB.db files. There can be many if using the --other_id_range option. Default is fuddly/data/directory/fmkDB.db Display Options: -f, --formula FORMULA The formula to plot, in the form "y ~ x" -poi, --points-of-interest POINTS_OF_INTEREST How many point of interest the plot should show. Default is none -gm, --grid-match {all,poi,auto} Should the plot grid specifically match some element. Possible options are 'all', 'poi' and 'auto'. Default is 'all' -hp, --hide-points Should the graph display every point above the line, or just the line. Default is to display the points Labels Configuration: -l, --labels ANNOTATIONS [ANNOTATIONS ...] Display the specified labels for each Data ID represented in the curve. ('t' for TYPE, 'g' for TARGET, 's' for SIZE, 'a' for ACK_DATE) -al, --async-labels ASYNC_ANNOTATIONS [ASYNC_ANNOTATIONS ...] Display the specified labels for each Async Data ID represented in the curve. ('i' for 'ID', 't' for TYPE, 'g' for TARGET, 's' for SIZE) Multiple Curves Options: -o, --other-data_ids OTHER_DATA_IDS Other data IDs to plot against the main one. All other options also apply to it -s, --vertical-shift VERTICAL_SHIFT When --other-id-range is used, specify the spacing between the curves. The shift is computed as the multiplication between the original curve height and this value Concrete output example ----------------------- .. _plotty_example: .. figure:: images/plotty_example.png :align: center Example of curve comparison using Plotty Given a simple command line:: fuddly tool plotty -id '2..12' -l t -al t i -df "%M:%S.%f" -poi 3 It is already possible to visualize trends, behaviors and anomalies. Comparison becomes easier !