Introduce teal_data class

[gogonzo]

Following introduction of teal_data class

[pawelru]

Usually there is only one blank line between nest_logo and everything that comes after

Suggested change

[gogonzo]

we need to fix this:

We need to reconsider following functions to have a robust and easy api.

• join_keys
• cdisc_join_keys
• get_cdisc_keys
• get_join_keys

First though is:

jk <- join_keys() # constructor
join_keys(jk) <- # setter
join_keys(jk) # getter

Above means that if join_keys could be a getter, then ``get_join_keyscould be removed. Settingjoin_keys` should be possible using:

join_keys(data)["dataset", "dataset"] <- character
join_keys(data) <- join_keys # set or replace whole keys object

cdisc_join_keys is just a wrapper around join_keys constructor - not possible to set nor get keys using this function. Most probably should have the same assertion for ... as join_keys

cdisc_join_keys()

get_cdisc_keys() could change - now it returns a list, but it could return JoinKeys. Unfortunately, get_cdisc_keys() is used widely across all packages. We will need to make a relevant changes there also (teal.transform :()

get_cdisc_keys(c("ADSL", "ADTTE", ...)) # returns JoinKeys

[chlebowa]

How about getting and setting keys on cdisc data with join_keys methods?

[gogonzo]

How about getting and setting keys on cdisc data with join_keys methods?

Not sure what you mean.

---

The way I see setting of the JoinKeys

data <- teal_data()
data <- within(data, {
  ADSL <- synthetic_cdisc_data("latest")$adsl
  ADRS <- synthetic_cdisc_data("latest")$adrs
  ADLB <- synthetic_cdisc_data("latest")$adlb
  ADELO <- ADLB
})
join_keys(data) <- join_keys() # technically it's (and should be) a default in teal_data()

datanames <- c("ADSL", "ADRS", "ADLB", "ADELO")
join_keys(data) <- default_cdisc_keys(datanames) # should warn about missing keys for any of the datasets
join_keys(data)["ADELO"] <- get_cdisc_keys("ADLB")
join_keys(data)["ADELO", "ADSL"] <- c("STUDYID", "USUBJID")

[chlebowa]

If cdisc_data is dropped as a class, this is almost exactly what I meant.
Can we have one function to generate the keys? join_keys(..., cdisc = FALSE) I may be missing something.

[gogonzo]

I don't know. I'm thinking there should be cdisc_data package with cdisc_join_keys and cdisc_data function maybe?

[gogonzo]

WHAT IF JoinKeys will be just a list with S3 class??
We could then drop many dependencies in other packages where JoinKeys are needed (teal.transform)

[chlebowa]

Sounds nice 👍

[gogonzo]

Opened a new PR to implement simplified JoinKeys api

#92