Merge pull request #23 from TidierOrg/str_count

Author: drizk1

src/docstrings.jl

@@ -1,12 +1,15 @@
-const docstring_str_detect = """
-                                 str_detect(string::String, pattern::Union{String, Regex})
+const docstring_str_detect  =
+"""
+    str_detect(string::String, pattern::Union{String, Regex}; overlap::Bool=false)
 
                              Determine if a string contains a certain pattern.
 
-                             # Arguments
-                             - `string`: The string to check.
-                             pattern: A string or a regular expression to find within the string.
-                             The pattern can include special logic:
+# Arguments
+- `string`: The string to check.
+- `pattern`: A string or a regular expression to find within the string.
+- `overlap`: Whether the pattern can overlap (default false)
+
+The pattern can include special logic:
 
                              Use | to represent "or" (e.g., "red|blue" matches any string that contains "red" or "blue").
                              Use & to represent "and" (e.g., "red&blue" matches any string that contains both "red" and "blue").

src/matching.jl

@@ -1,7 +1,7 @@
 """
 $docstring_str_count
 """
-function str_count(column, pattern::Union{String,Regex})
+function str_count(column, pattern::Union{String,Regex}; overlap::Bool=false)
     if ismissing(column)
         return (column)
     end
@@ -11,7 +11,7 @@ function str_count(column, pattern::Union{String,Regex})
     end
 
     # Count the number of matches for the regular expression
-    return length(collect(eachmatch(pattern, column)))
+    return length(collect(eachmatch(pattern, column, overlap=overlap)))
 end
 
 """