Function reference • TKCat

All functions

names(<MDB>) length(<MDB>) lengths(<MDB>) as.list(<MDB>) select(<MDB>) pull(<MDB>) c(<MDB>) merge(<MDB>): MDB

MDBs(): Get a list of MDB from metaMDB object

TKCat() `names<-`(<TKCat>) rename(<TKCat>) `[`(<TKCat>) c(<TKCat>): TKCat: a catalog of MDB

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

archive_chMDB(): Archive a chMDB in a chTKCat

as_chMDB(): Push an MDB object in a ClickHouse database

as_fileMDB(): Write an MDB object

as_memoMDB(): Convert any MDB object in a memoMDB object

chMDB() `names<-`(<chMDB>) rename(<chMDB>) `[`(<chMDB>) `[[`(<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

change_chTKCat_password(): Change chTKCat password

check_chTKCat(): Check a chTKCat object

collection_members() `collection_members<-`(): Collection members

compare_MDB(): Compare two MDB objects

count_records(): Count the number of records

create_chMDB(): Create a database in a chTKCat

create_chTKCat_user(): Create a chTKCat user

data_file_size(): Get the size of data files from a fileMDB object

data_files(): Get the data files from a fileMDB object

data_model(): Get object data model

data_tables(): Get object data tables

db_disconnect(): Disconnect an object from a database

db_info() `db_info<-`(): DB information

db_reconnect(): Reconnect an object to a database

db_tables(): Get the DB tables from a chMDB or metaMDB object

dims(): Detailed information about the format of the tables

.format_bytes(): Format bytes numbers in human readable values

drop_chMDB(): Drop a database from a chTKCat

drop_chTKCat_user(): Drop a user from a chTKCat object

empty_chMDB(): Empty a chMDB in a chTKCat

explore_MDBs(): Explore available MDB in a shiny web interface

`$`(<chMDB>) fileMDB() `names<-`(<fileMDB>) rename(<fileMDB>) `[`(<fileMDB>) `[[`(<fileMDB>) `$`(<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_with_tables(): Filter an MDB object according to provided tables

format(<chTKCat>): Format a chTKCat object for printing

get_MDB(): Get an MDB object from a TKCat related 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_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_local_collection(): Get the json definition of a local collection of concepts

get_query(): Get SQL query

get_shared_collections(): Get collections shared by 2 objects and return member combinations

heads(): Get the first records of each object data tables

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.MDB(): Check if the object is an MDB object

is.TKCat(): Check the object is a TKCat object

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.memoMDB(): Check if the object is a memoMDB object

is.metaMDB(): Check if the object is a metaMDB object

is_chMDB_public(): Is a chMDB public

is_current_chMDB(): Check if the chMDB object refers to the current instance of the MDB

join_mdb_tables(): Join connected tables

list_MDBs(): List available 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_local_collections(): List local collections of concepts

list_tables(): List tables in a clickhouse database

manage_chTKCat_users(): Manage user information in a shiny interface

map_collection_members(): Map different collection members

memoMDB() `names<-`(<memoMDB>) rename(<memoMDB>) `[`(<memoMDB>) `[[`(<memoMDB>) `$`(<memoMDB>): An MDB (Modeled DataBase) in memory: memoMDB

mergeTree_from_RelTableModel(): Create a ClickHouse MergeTree table from a ReDaMoR::RelTableModel

mergeTrees_from_RelDataModel(): Create ClickHouse MergeTree tables from a ReDaMoR::RelDataModel

metaMDB() `names<-`(<metaMDB>) rename(<metaMDB>) `[`(<metaMDB>) `[[`(<metaMDB>) `$`(<metaMDB>): A metaMDB object

read_collection_members(): Read a collection member JSON file

read_fileMDB(): Read a fileMDB 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

scan_fileMDBs(): Scan a catalog of fileMDB

search_MDB_fields(): Search fields in a TKCat related object

search_MDB_tables(): Search tables in a TKCat related object

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

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

write_MergeTree(): Write a Clickhouse MergeTree table

write_collection_members(): Write a collection member JSON file