tables#

Functions for generating plantuml code of CHADA tables from a single json or yaml file. A json source file must have the same format as the template in: mochada_kit/templates/chada_tables_template.json. A yaml source file must have the same format as the template in: mochada_kit/templates/chada_tables_template.yaml. The values for each key in the json/yaml file can either be plain text or formatting must be applied using the CREOLE or html syntax for plantuml shown here: https://plantuml.com/creole

Functions

copy_theme_to_local_folder(theme_name, ...)

Make a directory "themes" in output_path, then copies the theme "theme_name" from __THEMES_DIR__ to output_path/themes.

get_lines_from_keys(keys)

Given a list of 5 strings representing keys in the code for the json diagram, generate and return three other groups of lines needed for the puml code file.

handle_paths(data_path[, out_path, ...])

Handle paths for input and output, collects strings to be written at the top and bottom of the puml code, and supplies the data read from the json/yaml source file as a dict, if required.

write_chada_tables_plantuml(data_path[, ...])

Write a plantuml code file specifying a json diagram for each of five different cases.

write_chada_tables_single_plantuml(data_path)

Write a plantuml code file specifying a json diagram for each of five different cases.

write_chada_tables_whole_plantuml(data_path)

Write a plantuml code file specifying a json diagram showing a "contents" element --> all other elements (Overview, User Case, Experiment, Raw Data and Data Processing).