From 4c5d58bf82441fe7bf8660dd351480b72a761be1 Mon Sep 17 00:00:00 2001
From: Andreas Gammelgaard Damsbo <andreas@gdamsbo.dk>
Date: Thu, 18 Jan 2024 14:58:38 +0100
Subject: [PATCH] updated documentation

---
 DESCRIPTION | 10 +++++++---
 NAMESPACE   |  3 +++
 NEWS.md     |  4 +++-
 R/ds2dd.R   | 13 +++++++++----
 4 files changed, 22 insertions(+), 8 deletions(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index 65098c4..cd3430b 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -27,12 +27,13 @@ Suggests:
     jsonlite,
     testthat,
     Hmisc,
-    readr,
     knitr,
     rmarkdown,
     gt,
     usethis,
-    ggplot2
+    ggplot2,
+    haven,
+    here
 License: GPL (>= 3)
 Encoding: UTF-8
 LazyData: true
@@ -45,12 +46,15 @@ Imports:
     tidyr,
     tidyselect,
     keyring,
-    purrr
+    purrr,
+    readr,
+    stats
 Collate: 
     'utils.r'
     'process_user_input.r'
     'REDCap_split.r'
     'ds2dd.R'
+    'ds2dd_detailed.R'
     'easy_redcap.R'
     'read_redcap_tables.R'
     'redcap_wider.R'
diff --git a/NAMESPACE b/NAMESPACE
index 7cf22db..c790781 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -4,9 +4,11 @@ export(REDCap_split)
 export(clean_redcap_name)
 export(d2w)
 export(ds2dd)
+export(ds2dd_detailed)
 export(easy_redcap)
 export(focused_metadata)
 export(get_api_key)
+export(guess_time_only_filter)
 export(match_fields_to_form)
 export(read_redcap_tables)
 export(redcap_wider)
@@ -21,5 +23,6 @@ importFrom(keyring,key_get)
 importFrom(keyring,key_list)
 importFrom(keyring,key_set)
 importFrom(purrr,reduce)
+importFrom(readr,parse_time)
 importFrom(tidyr,pivot_wider)
 importFrom(tidyselect,all_of)
diff --git a/NEWS.md b/NEWS.md
index d7e2d32..348967c 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -2,7 +2,9 @@
 
 ### Functions
 
-* Fix: `ds2dd()`: uses correct default dd column names
+* Fix: `ds2dd()`: uses correct default dd column names. Will be deprecated.
+
+* NEW: `ds2dd_detailed()`: extension of the `ds2dd()`, which serves to preserve as much metadata as possible automatically. Depends on a group of helper functions also introduced. Of special note is the `guess_time_only_filter()`, which will try to guess which columns/variables should be formatted as time only formats. Supports hms time format. DETAILED INSTRUCTION AND VIGNETTE IS PENDING.
 
 ### Other
 
diff --git a/R/ds2dd.R b/R/ds2dd.R
index ce5d370..46bb052 100644
--- a/R/ds2dd.R
+++ b/R/ds2dd.R
@@ -1,8 +1,13 @@
-utils::globalVariables(c("redcapcast_meta"))
-#' Data set to data dictionary function
+utils::globalVariables(c("metadata_names"))
+#' (DEPRECATED) Data set to data dictionary function
 #'
+#' @description
+#' Creates a very basic data dictionary skeleton. Please see `ds2dd_detailed()`
+#' for a more advanced function.
+#'
+#' @details
 #' Migrated from stRoke ds2dd(). Fits better with the functionality of
-#' 'REDCapCAST'
+#' 'REDCapCAST'.
 #' @param ds data set
 #' @param record.id name or column number of id variable, moved to first row of
 #' data dictionary, character of integer. Default is "record_id".
@@ -16,7 +21,7 @@ utils::globalVariables(c("redcapcast_meta"))
 #' @param include.column.names Flag to give detailed output including new
 #' column names for original data set for upload.
 #' @param metadata Metadata column names. Default is the included
-#' REDCapCAST::redcapcast_data.
+#' REDCapCAST::metadata_names.
 #'
 #' @return data.frame or list of data.frame and vector
 #' @export