From d4aaac644b66423c83d43f2923672a363aa2ad8e Mon Sep 17 00:00:00 2001
From: Daniel <mail@danielluedecke.de>
Date: Tue, 12 Sep 2023 11:54:55 +0200
Subject: [PATCH] docs

---
 R/seek_variables.R    | 5 +++++
 man/seek_variables.Rd | 5 +++++
 2 files changed, 10 insertions(+)

diff --git a/R/seek_variables.R b/R/seek_variables.R
index 8797468a7..73384561b 100644
--- a/R/seek_variables.R
+++ b/R/seek_variables.R
@@ -7,6 +7,11 @@
 #' data, i.e. when the variables either have a `label` attribute or `labels`
 #' attribute.
 #'
+#' `seek_variables()` is particular useful for larger data frames with labelled
+#' data - finding the correct variable name can be a challenge. This function
+#' helps to find the required variables, when only certain patterns of variable
+#' names or labels are known.
+#'
 #' @param data A data frame.
 #' @param pattern Character string (regular expression) to be matched in `data`.
 #' May also be a character vector of length > 1. `pattern` is searched for in
diff --git a/man/seek_variables.Rd b/man/seek_variables.Rd
index 678cf98d8..928ccc48f 100644
--- a/man/seek_variables.Rd
+++ b/man/seek_variables.Rd
@@ -38,6 +38,11 @@ that either match the variable name (column name), variable labels, value labels
 or factor levels. Matching variable and value labels only works for "labelled"
 data, i.e. when the variables either have a \code{label} attribute or \code{labels}
 attribute.
+
+\code{seek_variables()} is particular useful for larger data frames with labelled
+data - finding the correct variable name can be a challenge. This function
+helps to find the required variables, when only certain patterns of variable
+names or labels are known.
 }
 \examples{
 # seek variables with "Length" in variable name or labels