Replace tags_df with labels_df

Replacing the function and reexporting `labels_df`
given that it is a crucial piece of functionality
for end users.

Author: chartgerink

R/labels_df.R

@@ -0,0 +1,3 @@
+#' @importFrom datatagr labels_df
+#' @export
+datatagr::labels_df

R/linelist-package.R

@@ -19,7 +19,7 @@
 #'
 #'   * [tags()]: to get the list of tags of a `linelist`
 #'
-#'   * [tags_df()]: to get a `data.frame` of all tagged variables
+#'   * [labels_df()]: to get a `data.frame` of all tagged variables
 #'
 #'   * [lost_tags_action()]: to change the behaviour of actions where tagged
 #'   variables are lost (e.g. removing columns storing tagged variables) to

R/make_linelist.R

@@ -28,7 +28,7 @@
 #' * [tags_types()]: for the associated accepted types/classes
 #' * [tags()]: for a list of tagged variables in a `linelist`
 #' * [set_tags()]: for modifying tags
-#' * [tags_df()]: for selecting variables by tags
+#' * [labels_df()]: for selecting variables by tags
 #'
 #' @details Known variable types include:
 #'

R/select.linelist.R

@@ -23,7 +23,7 @@
 #' @return The function returns a `linelist` with selected columns.
 #'
 #' @seealso
-#' * [tags_df()] to return a `data.frame` of all tagged variables
+#' * [labels_df()] to return a `data.frame` of all tagged variables
 #'
 select.linelist <- function(.data, ..., tags) {
 

R/select_tags.R

@@ -4,7 +4,7 @@
 #' @description
 #' `r lifecycle::badge("deprecated")`
 
-#' This function was  equivalent to running successively [tags_df()] and
+#' This function was  equivalent to running successively [labels_df()] and
 #' [dplyr::select()] on a `linelist` object.
 #' To encourage users to understand what is going on and in order to follow the
 #' software engineering good practice of providing just one way to do a given
@@ -21,7 +21,7 @@
 #'
 #' @seealso
 #' * [tags()] for existing tags in a `linelist`
-#' * [tags_df()] to get a `data.frame` of all tags
+#' * [labels_df()] to get a `data.frame` of all tags
 #'
 #' @examples
 #' if (require(outbreaks)) {
@@ -47,7 +47,7 @@
 #'   # Instead, use:
 #'   library(dplyr)
 #'   x %>%
-#'     tags_df() %>%
+#'     labels_df() %>%
 #'     select(gender, age)
 #' }
 #'
@@ -59,11 +59,11 @@ select_tags <- function(x, ...) {
     details =
       paste(
         "This function is deprecated:",
-        "use the two step `tags_df()` and `dplyr::select()` process instead"
+        "use the two step `labels_df()` and `dplyr::select()` process instead"
       )
   )
 
-  df <- tags_df(x)
+  df <- labels_df(x)
   dplyr::select(df, ...)
 
 }

R/tags_df.R

@@ -38,7 +38,7 @@
 validate_types <- function(x, ref_types = tags_types()) {
   checkmate::assert_class(x, "linelist")
 
-  df_to_check <- tags_df(x)
+  df_to_check <- labels_df(x)
 
   if (!all(names(df_to_check) %in% names(ref_types))) {
     stop(

R/validate_types.R

@@ -138,7 +138,7 @@ existing tags and the corresponding variables.
 
 * `tags_names()`: to list all recognized tag names; details on what the tags represent can be found at [`?make_linelist`](https://epiverse-trace.github.io/linelist/reference/make_linelist.html)
 
-* `tags_df()`: to obtain a `data.frame` of all the tagged variables in a `linelist`
+* `labels_df()`: to obtain a `data.frame` of all the tagged variables in a `linelist`
 
 ### Validation
 
@@ -269,7 +269,7 @@ x %>%
 
 # get all tagged variables in a data.frame
 x %>%
-  tags_df()
+  labels_df()
 ```
 
 ## Using safeguards