Tailored Knowledge Catalog
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘TKCat’ version 1.1.7
Help Pages
A C D E F G H I J K L M N P R S T U W misc
-- A --
| add_chMDB_user | Add a user to an MDB of a chTKCat object |
| add_chTKCat_collection | Import a collection in a chTKCat database |
| add_collection_member | Add a collection member to an MDB |
| add_feature_def | Add a feature definition to Knowledge Management Requirements (KMR) |
| add_helpers | Add a set of helper functions to a compatible object |
| add_helpers.KMR | Add a set of helper functions to a compatible object |
| add_helpers.MDB | Add a set of helper functions to a compatible object |
| add_km_feature | Add KM feature specifications to an MDB object |
| add_km_spec | Add empty KM specification tables to an MDB object |
| add_km_table | Add KM table specifications to an MDB object |
| add_property_values | Add possible values to an integer or a character feature property in KMR |
| add_table_def | Add a table definition to Knowledge Management Requirements (KMR) |
| add_table_features | Add possible features to table type in KMR |
| add_unit_def | Add a unit definition to Knowledge Management Requirements (KMR) |
| archive_chMDB | Archive a chMDB in a chTKCat |
| as.list.MDB | MDB |
| as_chMDB | Push an MDB object in a ClickHouse database |
| as_fileMDB | Write an MDB object |
| as_fileMDB.chMDB | Write an MDB object |
| as_fileMDB.fileMDB | Write an MDB object |
| as_fileMDB.memoMDB | Write an MDB object |
| as_fileMDB.metaMDB | Write an MDB object |
| as_KMR | Convert in a KMR object when possible |
| as_memoMDB | Convert any MDB object in a memoMDB object |
-- C --
| c.MDB | MDB |
| c.TKCat | TKCat: a catalog of MDB |
| change_chTKCat_password | Change chTKCat password |
| check_chTKCat | Check a chTKCat object |
| chMDB | An MDB (Modeled DataBase) relying on ClickHouse: chMDB |
| chTKCat | Connect to a ClickHouse TKCat instance |
| ch_insert | Insert records by batches in a Clickhouse table |
| collection_members | Collection members |
| collection_members.chMDB | Collection members |
| collection_members.chTKCat | Collection members |
| collection_members.fileMDB | Collection members |
| collection_members.memoMDB | Collection members |
| collection_members.metaMDB | Collection members |
| collection_members.TKCat | Collection members |
| collection_members<- | Collection members |
| collection_members<-.chMDB | Collection members |
| collection_members<-.fileMDB | Collection members |
| collection_members<-.memoMDB | Collection members |
| compare_MDB | Compare two MDB objects |
| count_records | Count the number of records |
| count_records.MDB | Count the number of records |
| create_chMDB | Create a database in a chTKCat |
| create_chTKCat_user | Create a chTKCat user |
| create_KMR | Create an MDB object with Knowledge Management Requirements (KMR) |
| create_POK | Create a piece of knowledge (POK) from an MDB and a KMRobject |
-- D --
| data_files | Get the data files from a fileMDB object |
| data_file_size | Get the size of data files from a fileMDB object |
| data_model | Get object data model |
| data_model.chMDB | Get object data model |
| data_model.fileMDB | Get object data model |
| data_model.memoMDB | Get object data model |
| data_model.metaMDB | Get object data model |
| data_tables | Get object data tables |
| data_tables.chMDB | Get object data tables |
| data_tables.fileMDB | Get object data tables |
| data_tables.memoMDB | Get object data tables |
| data_tables.metaMDB | Get object data tables |
| db_disconnect | Disconnect an object from a database |
| db_disconnect.chMDB | Disconnect an object from a database |
| db_disconnect.chTKCat | Disconnect an object from a database |
| db_disconnect.metaMDB | Disconnect an object from a database |
| db_info | DB information |
| db_info.chMDB | DB information |
| db_info.fileMDB | DB information |
| db_info.memoMDB | DB information |
| db_info.metaMDB | DB information |
| db_info<- | DB information |
| db_info<-.chMDB | DB information |
| db_info<-.fileMDB | DB information |
| db_info<-.memoMDB | DB information |
| db_info<-.metaMDB | DB information |
| db_reconnect | Reconnect an object to a database |
| db_reconnect.chMDB | Reconnect an object to a database |
| db_reconnect.chTKCat | Reconnect an object to a database |
| db_reconnect.metaMDB | Reconnect an object to a database |
| db_reconnect.POK | Reconnect an object to a database |
| db_tables | Get the DB tables from a chMDB or metaMDB object |
| decode_bin | Decode base64 string |
| dims | Detailed information about the format of the tables |
| dims.chMDB | Detailed information about the format of the tables |
| dims.fileMDB | Detailed information about the format of the tables |
| dims.memoMDB | Detailed information about the format of the tables |
| dims.metaMDB | Detailed information about the format of the tables |
| drop_chMDB | Drop a database from a chTKCat |
| drop_chTKCat_user | Drop a user from a chTKCat object |
-- E --
| empty_chMDB | Empty a chMDB in a chTKCat |
| encode_bin | Encode a binary file in a base64 string |
| explore_MDBs | Explore available MDB in a shiny web interface |
| explore_MDBs.chTKCat | Explore available MDB in a shiny web interface |
| explore_MDBs.TKCat | Explore available MDB in a shiny web interface |
-- F --
| fileMDB | An MDB (Modeled DataBase) based on files: fileMDB |
| filter.chMDB | Filter a chMDB object and return a memoMDB |
| filter.fileMDB | Filter a fileMDB object and return a memoMDB |
| filter.memoMDB | Filter a memoMDB object |
| filter.metaMDB | Filter a metaMDB object |
| filter_mdb_matrix | Filter a matrix stored in an MDB |
| filter_mdb_matrix.chMDB | Filter a matrix stored in an MDB |
| filter_mdb_matrix.fileMDB | Filter a matrix stored in an MDB |
| filter_mdb_matrix.memoMDB | Filter a matrix stored in an MDB |
| filter_mdb_matrix.metaMDB | Filter a matrix stored in an MDB |
| filter_with_tables | Filter an MDB object according to provided tables |
| filter_with_tables.chMDB | Filter an MDB object according to provided tables |
| filter_with_tables.fileMDB | Filter an MDB object according to provided tables |
| filter_with_tables.memoMDB | Filter an MDB object according to provided tables |
| filter_with_tables.metaMDB | Filter an MDB object according to provided tables |
| format.chTKCat | Format a chTKCat object for printing |
-- G --
| get_chMDB_metadata | Get the metadata of an MDB from a chTKCat connection |
| get_chMDB_timestamps | Get instance timestamps of an MDB in chTKCat |
| get_chTKCat_collection | Get a collection from a chTKCat |
| get_collection_mapper | Get the default mapper function for a collection |
| get_confrontation_report | Get the last generated MDB confrontation report |
| get_hosts | Get database hosts |
| get_hosts.chMDB | Get database hosts |
| get_hosts.chTKCat | Get database hosts |
| get_hosts.DBIConnection | Get database hosts |
| get_hosts.metaMDB | Get database hosts |
| get_KMR | Get a KMR object from a TKCat or a chTKCat object |
| get_km_spec | Get KM specifications from an MDB object |
| get_local_collection | Get the json definition of a local collection of concepts |
| get_MDB | Get an MDB object from a TKCat related object |
| get_MDB.chTKCat | Get an MDB object from a TKCat related object |
| get_MDB.TKCat | Get an MDB object from a TKCat related object |
| get_POK | Get a POK from a chTKCat connection or a TKCat object |
| get_query | Get SQL query |
| get_query.chMDB | Get SQL query |
| get_query.chTKCat | Get SQL query |
| get_R_helpers | Get a set of helper functions from an object |
| get_R_helpers.KMR | Get a set of helper functions from an object |
| get_R_helpers.MDB | Get a set of helper functions from an object |
| get_shared_collections | Get collections shared by 2 objects and return member combinations |
-- H --
| has_km_spec | Check if KM specifications are available in an MDB object |
| heads | Get the first records of each object data tables |
| heads.chMDB | Get the first records of each object data tables |
| heads.fileMDB | Get the first records of each object data tables |
| heads.memoMDB | Get the first records of each object data tables |
| heads.metaMDB | Get the first records of each object data tables |
-- I --
| import_collection_mapper | Import a function to map collection members |
| import_local_collection | Import a the definition of a collection of concepts in the local environment |
| init_chTKCat | Initialize a chTKCat database |
| is.chMDB | Check if the object is a chMDB object |
| is.chTKCat | Check the object is a chTKCat object |
| is.fileMDB | Check if the object is a fileMDB object |
| is.KMR | Check if an object represents Knowledge Management Requirements (KMR) |
| is.MDB | Check if the object is an MDB object |
| is.memoMDB | Check if the object is a memoMDB object |
| is.metaMDB | Check if the object is a metaMDB object |
| is.POK | Check if the object is a POK object |
| is.TKCat | Check the object is a TKCat object |
| is_chMDB_public | Is a chMDB public |
| is_current_chMDB | Check if the chMDB object refers to the current instance of the MDB |
-- J --
| join_mdb_tables | Join connected tables |
-- K --
| KMR | Create an MDB object with Knowledge Management Requirements (KMR) |
-- L --
| length.MDB | MDB |
| lengths.MDB | MDB |
| list_chMDB_timestamps | List instance timestamps of an MDB in chTKCat |
| list_chMDB_users | List users of an MDB of a chTKCat object |
| list_chTKCat_collections | List collections available in a chTKCat |
| list_chTKCat_users | List chTKCat user |
| list_feature_properties | List properties of a feature |
| list_local_collections | List local collections of concepts |
| list_MDBs | List available MDB |
| list_MDBs.chTKCat | List available MDB |
| list_MDBs.TKCat | List available MDB |
| list_measurements | List supported types of measurement |
| list_measurement_units | List possible units for a type of measurement |
| list_POKs | List available POK |
| list_property_values | List of supported values for an integer or a character property |
| list_tables | List tables in a clickhouse database |
| list_tables.chTKCat | List tables in a clickhouse database |
| list_tables.DBIConnection | List tables in a clickhouse database |
| list_table_features | List the features provided by a set of tables |
| list_table_types | List types of tables defined in a KMR object |
-- M --
| manage_chTKCat_users | Manage user information in a shiny interface |
| map_collection_members | Map different collection members |
| MDB | MDB |
| MDBs | Get a list of MDB from metaMDB object |
| memoMDB | An MDB (Modeled DataBase) in memory: memoMDB |
| merge.MDB | MDB |
| mergeTrees_from_RelDataModel | Create ClickHouse MergeTree tables from a ReDaMoR::RelDataModel |
| mergeTree_from_RelTableModel | Create a ClickHouse MergeTree table from a ReDaMoR::RelTableModel |
| metaMDB | A metaMDB object |
-- N --
| names.MDB | MDB |
| names<-.chMDB | An MDB (Modeled DataBase) relying on ClickHouse: chMDB |
| names<-.fileMDB | An MDB (Modeled DataBase) based on files: fileMDB |
| names<-.memoMDB | An MDB (Modeled DataBase) in memory: memoMDB |
| names<-.metaMDB | A metaMDB object |
| names<-.TKCat | TKCat: a catalog of MDB |
-- P --
| parse_R_helpers | Parse source code to get R helpers |
| POK | Create a piece of knowledge (POK) from an MDB and a KMRobject |
| pull.MDB | MDB |
-- R --
| read_collection_members | Read a collection member JSON file |
| read_fileMDB | Read a fileMDB from a path |
| read_KMR | Read KMR from a path |
| relational_tables | Get a list of relational tables |
| remove_chMDB_user | Drop a user of an MDB of a chTKCat object |
| remove_chTKCat_collection | Remove a collection from a chTKCat database |
| rename.chMDB | An MDB (Modeled DataBase) relying on ClickHouse: chMDB |
| rename.fileMDB | An MDB (Modeled DataBase) based on files: fileMDB |
| rename.memoMDB | An MDB (Modeled DataBase) in memory: memoMDB |
| rename.metaMDB | A metaMDB object |
| rename.TKCat | TKCat: a catalog of MDB |
| rm_km_feature | Remove KM feature specifications from an MDB object |
| rm_km_table | Remove KM table specifications from an MDB object |
-- S --
| scan_fileMDBs | Scan a catalog of fileMDB |
| search_MDB_fields | Search fields in a TKCat related object |
| search_MDB_fields.chTKCat | Search fields in a TKCat related object |
| search_MDB_fields.TKCat | Search fields in a TKCat related object |
| search_MDB_tables | Search tables in a TKCat related object |
| search_MDB_tables.chTKCat | Search tables in a TKCat related object |
| search_MDB_tables.TKCat | Search tables in a TKCat related object |
| select.MDB | MDB |
| set_chMDB_access | Set chMDB access |
| set_chMDB_timestamp | Set timestamp of the current version of an MDB in chTKCat |
| show_collection_def | Show the definition of a collection |
| slice.chMDB | Subset a chMDB object according to row position in one table and return a memoMDB |
| slice.fileMDB | Subset a fileMDB object according to row position in one table and return a memoMDB |
| slice.memoMDB | Subset a memoMDB object according to row position in one table |
| slice.metaMDB | Subset a metaMDB object according to row position in one table |
-- T --
| TKCat | TKCat: a catalog of MDB |
-- U --
| unarchive_chMDB | Unarchive a chMDB in a chTKCat |
| update_chMDB_grants | Update grants on tables in an MDB of a chTKCat object |
| update_chTKCat_user | Update a chTKCat user information |
-- W --
| write_collection_members | Write a collection member JSON file |
| write_MergeTree | Write a Clickhouse MergeTree table |
-- misc --
| $.chMDB | An MDB (Modeled DataBase) based on files: fileMDB |
| $.fileMDB | An MDB (Modeled DataBase) based on files: fileMDB |
| $.memoMDB | An MDB (Modeled DataBase) in memory: memoMDB |
| $.metaMDB | A metaMDB object |
| .format_bytes | Format bytes numbers in human readable values |
| [.chMDB | An MDB (Modeled DataBase) relying on ClickHouse: chMDB |
| [.fileMDB | An MDB (Modeled DataBase) based on files: fileMDB |
| [.memoMDB | An MDB (Modeled DataBase) in memory: memoMDB |
| [.metaMDB | A metaMDB object |
| [.TKCat | TKCat: a catalog of MDB |
| [[.chMDB | An MDB (Modeled DataBase) relying on ClickHouse: chMDB |
| [[.fileMDB | An MDB (Modeled DataBase) based on files: fileMDB |
| [[.memoMDB | An MDB (Modeled DataBase) in memory: memoMDB |
| [[.metaMDB | A metaMDB object |