Skip to content

Closes 293 check format tm #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bms63 merged 6 commits into from
Jan 9, 2026
Merged

Closes 293 check format tm #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ffbd3a3
Update format check to exclude character variables for datetime
cpiraux Jan 7, 2026
9334191
Update roxygen
cpiraux Jan 7, 2026
9a018e0
Update NEWS.md
cpiraux Jan 7, 2026
f5db29f
fix to use &&
cpiraux Jan 7, 2026
46c8758
Exclude ELTM from check
cpiraux Jan 8, 2026
93db35b
Update NEWS.md
bms63 Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ time variables. (#298)

## Bug Fixes
* Fixed verbose option bugs in `xportr_format()` and added missing `xportr.order_verbose` option (#318)
* Fixed `xportr_format()` to exclude variables ending with `ELTM` from the date/time format check, as these indicate time relative to an anchor time in SDTM or ADaM (#293)

## Breaking Changes and Deprecation

Expand Down
8 changes: 4 additions & 4 deletions R/format.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
#' producing a warning, or 'message' producing a message. A value of 'none'
#' will not output any messages.
#'
#' 1) If the variable has a suffix of `DT`, `DTM`, `TM` (indicating a
#' numeric date/time variable) then a message will be shown if there is
#' no format associated with it.
#' 1) If the variable has a suffix of `DT`, `DTM`, or `TM` excluding `ELTM`
#' (indicating a numeric date/time variable) , then a message will be shown
#' if there is no format associated with it.
#'
#' 2) If a variable is character then a message will be shown if there is
#' no `$` prefix in the associated format.
Expand Down Expand Up @@ -174,7 +174,7 @@ check_formats <- function(.df, format, verbose) {

# check that any variables ending DT, DTM, TM have a format
if (identical(format_sas, "")) {
if (isTRUE(grepl("(DT|DTM|TM)$", colnames(.df)[i]))) {
if (isTRUE(grepl("(DT|DTM|TM)$", colnames(.df)[i])) && !grepl("ELTM$", colnames(.df)[i])) {
message <- glue(
"(xportr::xportr_format) {encode_vars(colnames(.df)[i])} is expected to have a format but does not."
)
Expand Down
6 changes: 3 additions & 3 deletions man/xportr_format.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions tests/testthat/test-format.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,24 @@ test_that("xportr_format Test 5: Variable ending in TM should produce an error i
)
})

## Test 5: Variable ending in TM should not produce an error if the class is character (SDTM) ----
test_that("xportr_format Test 5: Variable ending in TM should not produce an error if the class is character (SDTM)", {
adsl <- data.frame(
USUBJID = c(1001, 1002, 1003),
EXELTM = c("1", "1", "2")
)

metadata <- data.frame(
dataset = c("adsl", "adsl"),
variable = c("USUBJID", "EXELTM"),
format = c(NA, NA)
)

expect_no_message(
xportr_format(adsl, metadata, verbose = "stop")
)
})

## Test 6: Variable ending in DTM should produce a warning if no format ----
test_that("xportr_format Test 6: Variable ending in DTM should produce a warning if no format", {
adsl <- data.frame(
Expand Down