Produce a data quality report for CC-HIC. This wraps all other functions as necessary to evaluate the whole database in one sweep. This can take some time!
report( database = NULL, username = NULL, password = NULL, host = "localhost", port = 5432, sqlite_file = NULL, output_folder = NULL, write_plots = TRUE, generate_report = TRUE )
| database | the database name for connection |
|---|---|
| username | the database username |
| password | the database password |
| host | the database server host IP address |
| port | the database port number |
| sqlite_file | the filename for the sqlite database (if using it) |
| output_folder | the path name for output files |
| write_plots | true/false to output plots. Otherwise only data processing takes place, which can be considerably quicker. |
| generate_report | triggers the build of the markdown report |
Specify the output folder in output_folder.