feat(paintcloud): add quiet argrument and allow WC object

Author: guo-yong-zhi

Project.toml

@@ -1,7 +1,7 @@
 name = "WordCloud"
 uuid = "6385f0a0-cb03-45b6-9089-4e0acc74b26b"
 authors = ["guoyongzhi <guo-yong-zhi@outlook.com>"]
-version = "1.3.0"
+version = "1.3.1"
 
 [deps]
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"

src/wc-class.jl

@@ -74,6 +74,7 @@ For more sophisticated text processing, please utilize the function [`processtex
   * You can skip `initialize!` and/or `layout!`, and these operations will be automatically performed with default parameters
   * You can use [`paintcloud`](@ref) and [`paintsvgcloud`](@ref) to obtain the final picture directly.
 """
+wordcloud(wc::WC) = wc
 wordcloud(wordsweights::Tuple; kargs...) = wordcloud(wordsweights...; kargs...)
 wordcloud(counter::AbstractDict; kargs...) = wordcloud(keys(counter) |> collect, values(counter) |> collect; kargs...)
 wordcloud(counter::AbstractVector{<:Union{Pair,Tuple,AbstractVector}}; kargs...) = wordcloud(first.(counter), [v[2] for v in counter]; kargs...)

src/wc-helper.jl

@@ -163,18 +163,19 @@ function paint(wc::WC, file, args...; kargs...)
 end
 
 """
-Generate a word cloud image from text. This function serves as a shortcut for `paint(generate!(wordcloud(...))...)`.
-For details on supported arguments, see:
-- [`wordcloud`](@ref)
-- [`paint`](@ref)
+Generate a word cloud image from text. This function acts as a convenient shortcut for `paint(generate!(wordcloud(...))...)`. 
+It accepts the same arguments as [`wordcloud`](@ref) and [`paint`](@ref). 
+# other arguments
+- quiet: suppresses the output of the generation process. defaults to true.
+
 See also: [`paintsvgcloud`](@ref)
 # Examples
 * paintcloud("holly bible")
-* paintcloud("holly bible", "result.svg")
+* paintcloud("holly bible", "result.svg", quiet=false)
 * paintcloud(["holly", "bible"], [0.7, 0.3], "result.png", background=false)
 * paintcloud("holly bible", angles=(0, 90), ratio=0.5)
 """
-function paintcloud(args...; paintfunc=paint, kargs...)
+function paintcloud(args...; quiet=true, paintfunc=paint, kargs...)
     if length(args) > 1 && last(args) isa AbstractString
         args_w, args_p = args[1:end-1], args[end:end]
     else
@@ -183,7 +184,11 @@ function paintcloud(args...; paintfunc=paint, kargs...)
     pkw = (:background, :ratio)
     kargs_w = filter(kw -> first(kw) ∉ pkw, kargs)
     kargs_p = filter(kw -> first(kw) ∈ pkw, kargs)
-    redirect_stdio(stdout=devnull, stderr=devnull) do
+    if quiet
+        redirect_stdio(stdout=devnull, stderr=devnull) do
+            paintfunc(generate!(wordcloud(args_w...; kargs_w...)), args_p...; kargs_p...)
+        end
+    else
         paintfunc(generate!(wordcloud(args_w...; kargs_w...)), args_p...; kargs_p...)
     end
 end

src/wc-method.jl

@@ -277,7 +277,7 @@ function printcollisions(wc)
     colllist = first.(totalcollisions(qtrees))
     get_text(i) = i > 1 ? wc.words[i - 1] : "#MASK#"
     if length(colllist) > 0
-        @warn "Have $(length(colllist)) collisions. Try setting a larger `epochs` and `retry`, or lower `density` and `spacing` in `wordcloud` to fix it."
+        @warn "There are $(length(colllist)) collisions detected. To address this, you might consider increasing the `epochs` or `retry` parameters within the `generate!` function, or reducing the `density` or `spacing` parameters in the `wordcloud` function."
         print("These words collide: ")
         foreach(ij->print(get_text(ij[1]), " & ", get_text(ij[2]), ", "), colllist)
         println()