Merge branch 'main' into 182_validate_teal_data@main

Signed-off-by: Marcin <[email protected]>

.pre-commit-config.yaml

@@ -6,7 +6,7 @@ default_language_version:
   python: python3
 repos:
   - repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.3.2.9025
+    rev: v0.3.2.9027
     hooks:
       - id: style-files
         name: Style code with `styler`

DESCRIPTION

@@ -1,8 +1,8 @@
 Type: Package
 Package: teal.data
 Title: Data Model for 'teal' Applications
-Version: 0.3.0.9009
-Date: 2023-11-10
+Version: 0.3.0.9010
+Date: 2023-11-20
 Authors@R: c(
     person("Dawid", "Kaledkowski", , "[email protected]", role = c("aut", "cre")),
     person("Pawel", "Rucki", , "[email protected]", role = "aut"),

NAMESPACE

@@ -1,13 +1,20 @@
 # Generated by roxygen2: do not edit by hand
 
-S3method("[",JoinKeys)
-S3method("[<-",JoinKeys)
-S3method("get_join_keys<-",JoinKeys)
-S3method("get_join_keys<-",teal_data)
+S3method("[",join_keys)
+S3method("[<-",join_keys)
+S3method("[[<-",join_keys)
+S3method("join_keys<-",join_keys)
+S3method("join_keys<-",teal_data)
+S3method("names<-",join_keys)
+S3method("parents<-",join_keys)
+S3method("parents<-",teal_data)
 S3method(as_cdisc,TealDataset)
 S3method(as_cdisc,TealDatasetConnector)
+S3method(c,join_key_set)
+S3method(c,join_keys)
 S3method(dataset,MultiAssayExperiment)
 S3method(dataset,data.frame)
+S3method(format,join_keys)
 S3method(get_attrs,TealDataset)
 S3method(get_code,TealDataAbstract)
 S3method(get_code,TealDataset)
@@ -27,10 +34,6 @@ S3method(get_datasets,TealDataAbstract)
 S3method(get_datasets,TealDataset)
 S3method(get_datasets,TealDatasetConnector)
 S3method(get_datasets,teal_data)
-S3method(get_join_keys,JoinKeys)
-S3method(get_join_keys,TealData)
-S3method(get_join_keys,default)
-S3method(get_join_keys,teal_data)
 S3method(get_key_duplicates,TealDataset)
 S3method(get_key_duplicates,data.frame)
 S3method(get_keys,TealDataAbstract)
@@ -42,6 +45,10 @@ S3method(get_raw_data,TealDatasetConnector)
 S3method(is_pulled,TealDataAbstract)
 S3method(is_pulled,TealDataset)
 S3method(is_pulled,TealDatasetConnector)
+S3method(join_keys,TealData)
+S3method(join_keys,default)
+S3method(join_keys,join_keys)
+S3method(join_keys,teal_data)
 S3method(load_dataset,TealDataset)
 S3method(load_dataset,TealDatasetConnector)
 S3method(load_datasets,TealData)
@@ -52,8 +59,9 @@ S3method(mutate_data,TealDataAbstract)
 S3method(mutate_dataset,TealDataAbstract)
 S3method(mutate_dataset,TealDataset)
 S3method(mutate_dataset,TealDatasetConnector)
-S3method(mutate_join_keys,JoinKeys)
-S3method(mutate_join_keys,TealData)
+S3method(parents,join_keys)
+S3method(parents,teal_data)
+S3method(print,join_keys)
 S3method(set_args,CallableCode)
 S3method(set_args,CallableFunction)
 S3method(set_args,TealDatasetConnector)
@@ -69,6 +77,8 @@ export("col_labels<-")
 export("data_label<-")
 export("datanames<-")
 export("get_join_keys<-")
+export("join_keys<-")
+export("parents<-")
 export(as_cdisc)
 export(callable_code)
 export(callable_function)
@@ -79,7 +89,6 @@ export(cdisc_dataset)
 export(cdisc_dataset_connector)
 export(cdisc_dataset_connector_file)
 export(cdisc_dataset_file)
-export(cdisc_join_keys)
 export(code_cdisc_dataset_connector)
 export(code_dataset_connector)
 export(col_labels)
@@ -93,6 +102,7 @@ export(dataset)
 export(dataset_connector)
 export(dataset_connector_file)
 export(dataset_file)
+export(default_cdisc_join_keys)
 export(example_cdisc_data)
 export(fun_cdisc_dataset_connector)
 export(fun_dataset_connector)
@@ -116,7 +126,8 @@ export(load_datasets)
 export(mae_dataset)
 export(mutate_data)
 export(mutate_dataset)
-export(mutate_join_keys)
+export(parent)
+export(parents)
 export(python_cdisc_dataset_connector)
 export(python_code)
 export(python_dataset_connector)
@@ -139,5 +150,6 @@ import(teal.code)
 importFrom(digest,digest)
 importFrom(logger,log_trace)
 importFrom(methods,show)
+importFrom(rlang,`%||%`)
 importFrom(shinyjs,useShinyjs)
 importFrom(stats,setNames)

NEWS.md

@@ -2,12 +2,16 @@
 
 ### Enhancements
 * Simplified `join_key` to better support primary keys.
-* Added subset and subset-assignment to `JoinKeySet` class to manipulate relationship pair keys _(`[` and `[<-`)_.
+* `JoinKey` `R6` object was removed in favor of a list-like object with class name `join_keys`. Subset operators and assignments are supported (`[`, `[[`, `[<-` and `[[<-`)
+* `join_keys` function works as a constructor, getter and setter.
 
 ### Breaking changes
 
 * Introduced new data class (`teal_data`) which replaces deprecated `TealData`. New data class becomes a standard input for whole `teal` framework.
 * Deprecated `teal_data` constructor when `TealDataset`, `TealDatasetConnector` or `TealDataConnector` objects are provided. New delayed data loading functions introduced in `teal` package.
+* `JoinKeySet` class was renamed to `join_key_set`.
+* `JoinKeys` class was renamed to `join_keys`
+
 ### Miscellaneous
 * Specified minimal version of package dependencies.