Learn R Programming

TKCat (version 1.1.12)

Tailored Knowledge Catalog

Description

Facilitate the management of data from knowledge resources that are frequently used alone or together in research environments. In 'TKCat', knowledge resources are manipulated as modeled database (MDB) objects. These objects provide access to the data tables along with a general description of the resource and a detail data model documenting the tables, their fields and their relationships. These MDBs are then gathered in catalogs that can be easily explored an shared. Finally, 'TKCat' provides tools to easily subset, filter and combine MDBs and create new catalogs suited for specific needs.

Copy Link

Version

Install

install.packages('TKCat')

Monthly Downloads

284

Version

1.1.12

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Patrice Godard

Last Published

March 17th, 2025

Functions in TKCat (1.1.12)

as_KMR

Convert in a KMR object when possible
as_memoMDB

Convert any MDB object in a memoMDB object
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
ch_insert

Insert records by batches in a Clickhouse table
as_chMDB

Push an MDB object in a ClickHouse database
create_chTKCat_user

Create a chTKCat user
change_chTKCat_password

Change chTKCat password
filter.chMDB

Filter a chMDB object and return a memoMDB
collection_members.TKCat

Collection members
db_info.chMDB

DB information
create_chMDB

Create a database in a chTKCat
chMDB

An MDB (Modeled DataBase) relying on ClickHouse: chMDB
db_disconnect.chMDB

Disconnect an object from a database
check_chTKCat

Check a chTKCat object
$.chMDB

An MDB (Modeled DataBase) based on files: fileMDB
chTKCat

Connect to a ClickHouse TKCat instance
data_model.chMDB

Get object data model
encode_bin

Encode a binary file in a base64 string
drop_chTKCat_user

Drop a user from a chTKCat object
data_tables.chMDB

Get object data tables
empty_chMDB

Empty a chMDB in a chTKCat
compare_MDB

Compare two MDB objects
count_records.MDB

Count the number of records
filter_mdb_matrix.chMDB

Filter a matrix stored in an MDB
filter.metaMDB

Filter a metaMDB object
data_files

Get the data files from a fileMDB object
data_file_size

Get the size of data files from a fileMDB object
filter.fileMDB

Filter a fileMDB object and return a memoMDB
drop_chMDB

Drop a database from a chTKCat
get_KMR

Get a KMR object from a TKCat or a chTKCat object
.format_bytes

Format bytes numbers in human readable values
create_KMR

Create an MDB object with Knowledge Management Requirements (KMR)
get_POK

Get a POK from a chTKCat connection or a TKCat object
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_R_helpers.MDB

Get a set of helper functions from an object
create_POK

Create a piece of knowledge (POK) from an MDB and a KMRobject
db_reconnect.POK

Reconnect an object to a database
init_chTKCat

Initialize a chTKCat database
is.KMR

Check if an object represents Knowledge Management Requirements (KMR)
db_tables

Get the DB tables from a chMDB or metaMDB object
dims.chMDB

Detailed information about the format of the tables
filter_with_tables.chMDB

Filter an MDB object according to provided tables
decode_bin

Decode base64 string
explore_MDBs.TKCat

Explore available MDB in a shiny web interface
join_mdb_tables

Join connected tables
list_table_features

List the features provided by a set of tables
list_table_types

List types of tables defined in a KMR object
list_MDBs.TKCat

List available MDB
format.chTKCat

Format a chTKCat object for printing
filter.memoMDB

Filter a memoMDB object
get_local_collection

Get the json definition of a local collection of concepts
get_confrontation_report

Get the last generated MDB confrontation report
get_km_spec

Get KM specifications from an MDB object
is.memoMDB

Check if the object is a memoMDB object
is.metaMDB

Check if the object is a metaMDB object
get_chTKCat_collection

Get a collection from a chTKCat
get_collection_mapper

Get the default mapper function for a collection
get_hosts.DBIConnection

Get database hosts
list_chTKCat_users

List chTKCat user
is.chMDB

Check if the object is a chMDB object
is.TKCat

Check the object is a TKCat object
is_chMDB_public

Is a chMDB public
has_km_spec

Check if KM specifications are available in an MDB object
list_feature_properties

List properties of a feature
get_MDB.TKCat

Get an MDB object from a TKCat related object
is_current_chMDB

Check if the chMDB object refers to the current instance of the MDB
list_chMDB_users

List users of an MDB of a chTKCat object
list_chTKCat_collections

List collections available in a chTKCat
scan_fileMDBs

Scan a catalog of fileMDB
read_collection_members

Read a collection member JSON file
read_KMR

Read KMR from a path
is.MDB

Check if the object is an MDB object
map_collection_members

Map different collection members
memoMDB

An MDB (Modeled DataBase) in memory: memoMDB
list_POKs

List available POK
list_chMDB_timestamps

List instance timestamps of an MDB in chTKCat
heads.chMDB

Get the first records of each object data tables
search_MDB_fields.TKCat

Search fields in a TKCat related object
rm_km_table

Remove KM table specifications from an MDB object
rm_km_feature

Remove KM feature specifications from an MDB object
list_local_collections

List local collections of concepts
remove_chMDB_user

Drop a user of an MDB of a chTKCat object
remove_chTKCat_collection

Remove a collection from a chTKCat database
update_chTKCat_user

Update a chTKCat user information
write_MergeTree

parse_R_helpers

Parse source code to get R helpers
metaMDB

A metaMDB object
list_measurements

List supported types of measurement
list_property_values

List of supported values for an integer or a character property
is.POK

Check if the object is a POK object
list_measurement_units

List possible units for a type of measurement
set_chMDB_timestamp

Set timestamp of the current version of an MDB in chTKCat
show_collection_def

Show the definition of a collection
list_tables.DBIConnection

List tables in a clickhouse database
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
write_collection_members

Write a collection member JSON file
manage_chTKCat_users

Manage user information in a shiny interface
get_query.chMDB

Get SQL query
unarchive_chMDB

Unarchive a chMDB in a chTKCat
set_chMDB_access

Set chMDB access
get_shared_collections

Get collections shared by 2 objects and return member combinations
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
search_MDB_tables.TKCat

Search tables in a TKCat related object
update_chMDB_grants

Update grants on tables in an MDB of a chTKCat object
is.fileMDB

Check if the object is a fileMDB object
is.chTKCat

Check the object is a chTKCat object
mergeTree_from_RelTableModel

Create a ClickHouse MergeTree table from a ReDaMoR::RelTableModel
mergeTrees_from_RelDataModel

Create ClickHouse MergeTree tables from a ReDaMoR::RelDataModel
relational_tables

Get a list of relational tables
slice.metaMDB

Subset a metaMDB object according to row position in one table
slice.memoMDB

Subset a memoMDB object according to row position in one table
read_fileMDB

Read a fileMDB from a path
add_feature_def

Add a feature definition to Knowledge Management Requirements (KMR)
MDB

MDB
add_km_spec

Add empty KM specification tables to an MDB object
add_km_feature

Add KM feature specifications to an MDB object
MDBs

Get a list of MDB from metaMDB object
add_collection_member

Add a collection member to an MDB
add_helpers.MDB

Add a set of helper functions to a compatible object
add_chTKCat_collection

Import a collection in a chTKCat database
add_chMDB_user

Add a user to an MDB of a chTKCat object
TKCat

TKCat: a catalog of MDB
add_table_def

Add a table definition to Knowledge Management Requirements (KMR)
add_km_table

Add KM table specifications to an MDB object
as_fileMDB.chMDB

Write an MDB object
add_property_values

Add possible values to an integer or a character feature property in KMR