Skip to contents

[Stable] Get dataset attributes in form of named list.

Usage

get_attrs(x)

# S3 method for TealDataset
get_attrs(x)

Arguments

x

an object of (TealDataset) class

Value

named list of object attributes

Examples

# TealDataset --------

library(scda)
ADSL <- synthetic_cdisc_data("latest")$adsl

x1 <- dataset("ADSL", x = ADSL, label = "custom label")
get_attrs(x1)
#> $names
#>  [1] "STUDYID"             "USUBJID"             "SUBJID"             
#>  [4] "SITEID"              "AGE"                 "AGEU"               
#>  [7] "SEX"                 "RACE"                "ETHNIC"             
#> [10] "COUNTRY"             "DTHFL"               "INVID"              
#> [13] "INVNAM"              "ARM"                 "ARMCD"              
#> [16] "ACTARM"              "ACTARMCD"            "TRT01P"             
#> [19] "TRT01A"              "REGION1"             "STRATA1"            
#> [22] "STRATA2"             "BMRKR1"              "BMRKR2"             
#> [25] "ITTFL"               "SAFFL"               "BMEASIFL"           
#> [28] "BEP01FL"             "RANDDT"              "TRTSDTM"            
#> [31] "TRTEDTM"             "EOSSTT"              "EOTSTT"             
#> [34] "EOSDT"               "EOSDY"               "DCSREAS"            
#> [37] "DTHDT"               "DTHCAUS"             "DTHCAT"             
#> [40] "LDDTHELD"            "LDDTHGR1"            "LSTALVDT"           
#> [43] "DTHADY"              "study_duration_secs"
#> 
#> $row.names
#>   [1]   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18
#>  [19]  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36
#>  [37]  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54
#>  [55]  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72
#>  [73]  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90
#>  [91]  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108
#> [109] 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
#> [127] 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
#> [145] 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
#> [163] 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
#> [181] 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
#> [199] 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
#> [217] 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
#> [235] 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
#> [253] 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
#> [271] 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
#> [289] 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
#> [307] 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
#> [325] 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
#> [343] 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
#> [361] 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
#> [379] 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
#> [397] 397 398 399 400
#> 
#> $class
#> [1] "tbl_df"     "tbl"        "data.frame"
#> 
#> $label
#> [1] "Subject Level Analysis Dataset"
#> 
#> $`creation date`
#> [1] "2022-05-19"
#> 
#> $column_labels
#>                                   STUDYID 
#>                        "Study Identifier" 
#>                                   USUBJID 
#>               "Unique Subject Identifier" 
#>                                    SUBJID 
#>        "Subject Identifier for the Study" 
#>                                    SITEID 
#>                   "Study Site Identifier" 
#>                                       AGE 
#>                                     "Age" 
#>                                      AGEU 
#>                               "Age Units" 
#>                                       SEX 
#>                                     "Sex" 
#>                                      RACE 
#>                                    "Race" 
#>                                    ETHNIC 
#>                               "Ethnicity" 
#>                                   COUNTRY 
#>                                 "Country" 
#>                                     DTHFL 
#>                      "Subject Death Flag" 
#>                                     INVID 
#>                 "Investigator Identifier" 
#>                                    INVNAM 
#>                       "Investigator Name" 
#>                                       ARM 
#>              "Description of Planned Arm" 
#>                                     ARMCD 
#>                        "Planned Arm Code" 
#>                                    ACTARM 
#>               "Description of Actual Arm" 
#>                                  ACTARMCD 
#>                         "Actual Arm Code" 
#>                                    TRT01P 
#>         "Planned Treatment for Period 01" 
#>                                    TRT01A 
#>          "Actual Treatment for Period 01" 
#>                                   REGION1 
#>                     "Geographic Region 1" 
#>                                   STRATA1 
#>                 "Stratification Factor 1" 
#>                                   STRATA2 
#>                 "Stratification Factor 2" 
#>                                    BMRKR1 
#>            "Continuous Level Biomarker 1" 
#>                                    BMRKR2 
#>           "Categorical Level Biomarker 2" 
#>                                     ITTFL 
#>         "Intent-To-Treat Population Flag" 
#>                                     SAFFL 
#>                  "Safety Population Flag" 
#>                                  BMEASIFL 
#>      "Response Evaluable Population Flag" 
#>                                   BEP01FL 
#>     "Biomarker Evaluable Population Flag" 
#>                                    RANDDT 
#>                   "Date of Randomization" 
#>                                   TRTSDTM 
#> "Datetime of First Exposure to Treatment" 
#>                                   TRTEDTM 
#>  "Datetime of Last Exposure to Treatment" 
#>                                    EOSSTT 
#>                     "End of Study Status" 
#>                                    EOTSTT 
#>                 "End of Treatment Status" 
#>                                     EOSDT 
#>                       "End of Study Date" 
#>                                     EOSDY 
#>               "End of Study Relative Day" 
#>                                   DCSREAS 
#>   "Reason for Discontinuation from Study" 
#>                                     DTHDT 
#>                           "Date of Death" 
#>                                   DTHCAUS 
#>                          "Cause of Death" 
#>                                    DTHCAT 
#>                 "Cause of Death Category" 
#>                                  LDDTHELD 
#>    "Elapsed Days from Last Dose to Death" 
#>                                  LDDTHGR1 
#> "Last Dose to Death - Days Elapsed Grp 1" 
#>                                  LSTALVDT 
#>                   "Date Last Known Alive" 
#>                                    DTHADY 
#>                   "Relative Day of Death" 
#>                       study_duration_secs 
#>       "NOT A STANDARD BUT NEEDED FOR RCD" 
#> 
#> $row_labels
#> NULL
#> 
#> $dataname
#> [1] "ADSL"
#> 
#> $dataset_label
#> [1] "custom label"
#> 
#> $keys
#> character(0)
#> 

x2 <- dataset(
  "ADSL",
  x = ADSL,
  keys = get_cdisc_keys("ADSL"),
  label = "custom label"
)
get_attrs(x2)
#> $names
#>  [1] "STUDYID"             "USUBJID"             "SUBJID"             
#>  [4] "SITEID"              "AGE"                 "AGEU"               
#>  [7] "SEX"                 "RACE"                "ETHNIC"             
#> [10] "COUNTRY"             "DTHFL"               "INVID"              
#> [13] "INVNAM"              "ARM"                 "ARMCD"              
#> [16] "ACTARM"              "ACTARMCD"            "TRT01P"             
#> [19] "TRT01A"              "REGION1"             "STRATA1"            
#> [22] "STRATA2"             "BMRKR1"              "BMRKR2"             
#> [25] "ITTFL"               "SAFFL"               "BMEASIFL"           
#> [28] "BEP01FL"             "RANDDT"              "TRTSDTM"            
#> [31] "TRTEDTM"             "EOSSTT"              "EOTSTT"             
#> [34] "EOSDT"               "EOSDY"               "DCSREAS"            
#> [37] "DTHDT"               "DTHCAUS"             "DTHCAT"             
#> [40] "LDDTHELD"            "LDDTHGR1"            "LSTALVDT"           
#> [43] "DTHADY"              "study_duration_secs"
#> 
#> $row.names
#>   [1]   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18
#>  [19]  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36
#>  [37]  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54
#>  [55]  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72
#>  [73]  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90
#>  [91]  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108
#> [109] 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
#> [127] 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
#> [145] 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
#> [163] 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
#> [181] 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
#> [199] 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
#> [217] 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
#> [235] 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
#> [253] 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
#> [271] 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
#> [289] 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
#> [307] 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
#> [325] 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
#> [343] 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
#> [361] 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
#> [379] 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
#> [397] 397 398 399 400
#> 
#> $class
#> [1] "tbl_df"     "tbl"        "data.frame"
#> 
#> $label
#> [1] "Subject Level Analysis Dataset"
#> 
#> $`creation date`
#> [1] "2022-05-19"
#> 
#> $column_labels
#>                                   STUDYID 
#>                        "Study Identifier" 
#>                                   USUBJID 
#>               "Unique Subject Identifier" 
#>                                    SUBJID 
#>        "Subject Identifier for the Study" 
#>                                    SITEID 
#>                   "Study Site Identifier" 
#>                                       AGE 
#>                                     "Age" 
#>                                      AGEU 
#>                               "Age Units" 
#>                                       SEX 
#>                                     "Sex" 
#>                                      RACE 
#>                                    "Race" 
#>                                    ETHNIC 
#>                               "Ethnicity" 
#>                                   COUNTRY 
#>                                 "Country" 
#>                                     DTHFL 
#>                      "Subject Death Flag" 
#>                                     INVID 
#>                 "Investigator Identifier" 
#>                                    INVNAM 
#>                       "Investigator Name" 
#>                                       ARM 
#>              "Description of Planned Arm" 
#>                                     ARMCD 
#>                        "Planned Arm Code" 
#>                                    ACTARM 
#>               "Description of Actual Arm" 
#>                                  ACTARMCD 
#>                         "Actual Arm Code" 
#>                                    TRT01P 
#>         "Planned Treatment for Period 01" 
#>                                    TRT01A 
#>          "Actual Treatment for Period 01" 
#>                                   REGION1 
#>                     "Geographic Region 1" 
#>                                   STRATA1 
#>                 "Stratification Factor 1" 
#>                                   STRATA2 
#>                 "Stratification Factor 2" 
#>                                    BMRKR1 
#>            "Continuous Level Biomarker 1" 
#>                                    BMRKR2 
#>           "Categorical Level Biomarker 2" 
#>                                     ITTFL 
#>         "Intent-To-Treat Population Flag" 
#>                                     SAFFL 
#>                  "Safety Population Flag" 
#>                                  BMEASIFL 
#>      "Response Evaluable Population Flag" 
#>                                   BEP01FL 
#>     "Biomarker Evaluable Population Flag" 
#>                                    RANDDT 
#>                   "Date of Randomization" 
#>                                   TRTSDTM 
#> "Datetime of First Exposure to Treatment" 
#>                                   TRTEDTM 
#>  "Datetime of Last Exposure to Treatment" 
#>                                    EOSSTT 
#>                     "End of Study Status" 
#>                                    EOTSTT 
#>                 "End of Treatment Status" 
#>                                     EOSDT 
#>                       "End of Study Date" 
#>                                     EOSDY 
#>               "End of Study Relative Day" 
#>                                   DCSREAS 
#>   "Reason for Discontinuation from Study" 
#>                                     DTHDT 
#>                           "Date of Death" 
#>                                   DTHCAUS 
#>                          "Cause of Death" 
#>                                    DTHCAT 
#>                 "Cause of Death Category" 
#>                                  LDDTHELD 
#>    "Elapsed Days from Last Dose to Death" 
#>                                  LDDTHGR1 
#> "Last Dose to Death - Days Elapsed Grp 1" 
#>                                  LSTALVDT 
#>                   "Date Last Known Alive" 
#>                                    DTHADY 
#>                   "Relative Day of Death" 
#>                       study_duration_secs 
#>       "NOT A STANDARD BUT NEEDED FOR RCD" 
#> 
#> $row_labels
#> NULL
#> 
#> $dataname
#> [1] "ADSL"
#> 
#> $dataset_label
#> [1] "custom label"
#> 
#> $keys
#> [1] "STUDYID" "USUBJID"
#> 

# CDISCTealDataset --------

library(scda)
ADSL <- synthetic_cdisc_data("latest")$adsl
x3 <- cdisc_dataset(
  "ADSL",
  x = ADSL,
  keys = get_cdisc_keys("ADSL"),
  label = "custom label"
)
get_attrs(x3)
#> $names
#>  [1] "STUDYID"             "USUBJID"             "SUBJID"             
#>  [4] "SITEID"              "AGE"                 "AGEU"               
#>  [7] "SEX"                 "RACE"                "ETHNIC"             
#> [10] "COUNTRY"             "DTHFL"               "INVID"              
#> [13] "INVNAM"              "ARM"                 "ARMCD"              
#> [16] "ACTARM"              "ACTARMCD"            "TRT01P"             
#> [19] "TRT01A"              "REGION1"             "STRATA1"            
#> [22] "STRATA2"             "BMRKR1"              "BMRKR2"             
#> [25] "ITTFL"               "SAFFL"               "BMEASIFL"           
#> [28] "BEP01FL"             "RANDDT"              "TRTSDTM"            
#> [31] "TRTEDTM"             "EOSSTT"              "EOTSTT"             
#> [34] "EOSDT"               "EOSDY"               "DCSREAS"            
#> [37] "DTHDT"               "DTHCAUS"             "DTHCAT"             
#> [40] "LDDTHELD"            "LDDTHGR1"            "LSTALVDT"           
#> [43] "DTHADY"              "study_duration_secs"
#> 
#> $row.names
#>   [1]   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18
#>  [19]  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36
#>  [37]  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54
#>  [55]  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72
#>  [73]  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90
#>  [91]  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108
#> [109] 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
#> [127] 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
#> [145] 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
#> [163] 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
#> [181] 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
#> [199] 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
#> [217] 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
#> [235] 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
#> [253] 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
#> [271] 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
#> [289] 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
#> [307] 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
#> [325] 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
#> [343] 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
#> [361] 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
#> [379] 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
#> [397] 397 398 399 400
#> 
#> $class
#> [1] "tbl_df"     "tbl"        "data.frame"
#> 
#> $label
#> [1] "Subject Level Analysis Dataset"
#> 
#> $`creation date`
#> [1] "2022-05-19"
#> 
#> $column_labels
#>                                   STUDYID 
#>                        "Study Identifier" 
#>                                   USUBJID 
#>               "Unique Subject Identifier" 
#>                                    SUBJID 
#>        "Subject Identifier for the Study" 
#>                                    SITEID 
#>                   "Study Site Identifier" 
#>                                       AGE 
#>                                     "Age" 
#>                                      AGEU 
#>                               "Age Units" 
#>                                       SEX 
#>                                     "Sex" 
#>                                      RACE 
#>                                    "Race" 
#>                                    ETHNIC 
#>                               "Ethnicity" 
#>                                   COUNTRY 
#>                                 "Country" 
#>                                     DTHFL 
#>                      "Subject Death Flag" 
#>                                     INVID 
#>                 "Investigator Identifier" 
#>                                    INVNAM 
#>                       "Investigator Name" 
#>                                       ARM 
#>              "Description of Planned Arm" 
#>                                     ARMCD 
#>                        "Planned Arm Code" 
#>                                    ACTARM 
#>               "Description of Actual Arm" 
#>                                  ACTARMCD 
#>                         "Actual Arm Code" 
#>                                    TRT01P 
#>         "Planned Treatment for Period 01" 
#>                                    TRT01A 
#>          "Actual Treatment for Period 01" 
#>                                   REGION1 
#>                     "Geographic Region 1" 
#>                                   STRATA1 
#>                 "Stratification Factor 1" 
#>                                   STRATA2 
#>                 "Stratification Factor 2" 
#>                                    BMRKR1 
#>            "Continuous Level Biomarker 1" 
#>                                    BMRKR2 
#>           "Categorical Level Biomarker 2" 
#>                                     ITTFL 
#>         "Intent-To-Treat Population Flag" 
#>                                     SAFFL 
#>                  "Safety Population Flag" 
#>                                  BMEASIFL 
#>      "Response Evaluable Population Flag" 
#>                                   BEP01FL 
#>     "Biomarker Evaluable Population Flag" 
#>                                    RANDDT 
#>                   "Date of Randomization" 
#>                                   TRTSDTM 
#> "Datetime of First Exposure to Treatment" 
#>                                   TRTEDTM 
#>  "Datetime of Last Exposure to Treatment" 
#>                                    EOSSTT 
#>                     "End of Study Status" 
#>                                    EOTSTT 
#>                 "End of Treatment Status" 
#>                                     EOSDT 
#>                       "End of Study Date" 
#>                                     EOSDY 
#>               "End of Study Relative Day" 
#>                                   DCSREAS 
#>   "Reason for Discontinuation from Study" 
#>                                     DTHDT 
#>                           "Date of Death" 
#>                                   DTHCAUS 
#>                          "Cause of Death" 
#>                                    DTHCAT 
#>                 "Cause of Death Category" 
#>                                  LDDTHELD 
#>    "Elapsed Days from Last Dose to Death" 
#>                                  LDDTHGR1 
#> "Last Dose to Death - Days Elapsed Grp 1" 
#>                                  LSTALVDT 
#>                   "Date Last Known Alive" 
#>                                    DTHADY 
#>                   "Relative Day of Death" 
#>                       study_duration_secs 
#>       "NOT A STANDARD BUT NEEDED FOR RCD" 
#> 
#> $row_labels
#> NULL
#> 
#> $dataname
#> [1] "ADSL"
#> 
#> $dataset_label
#> [1] "custom label"
#> 
#> $keys
#> [1] "STUDYID" "USUBJID"
#> 
#> $parent
#> character(0)
#>