Julia中DataFrame列箱线图自定义函数报错的原因与修复

问题场景 #

在Julia中使用StatsPlots.jl绘制DataFrame列的箱线图时，单独执行以下代码可以正常工作：

@df df boxplot(["a"], :a, fillalpha=0.75, linewidth=2)

但将逻辑封装为自定义函数后：

function BoxPlotColumn(col::Union{Symbol, String}, df::DataFrame)
    if isa(col, String)
        @df df boxplot([col], Symbol(col), fillalpha=0.75, linewidth=2)
    else
        @df df boxplot([String(col)], col, fillalpha=0.75, linewidth=2)
    end
end

调用BoxPlotColumn("a", df)时抛出错误：

ERROR: Cannot convert Symbol to series data for plotting
Stacktrace:
  [1] error(s::String)
    @ Base .\error.jl:35
  [2] _prepare_series_data(x::Symbol)
    @ RecipesPipeline C:\Users\Shayan\.julia\packages\RecipesPipeline\OXGmH\src\series.jl:8
  [3] _series_data_vector(x::Symbol, plotattributes::Dict{Symbol, Any})
    @ RecipesPipeline C:\Users\Shayan\.julia\packages\RecipesPipeline\OXGmH\src\series.jl:35
  [4] macro expansion
    @ C:\Users\Shayan\.julia\packages\RecipesPipeline\OXGmH\src\series.jl:135 [inlined]
  [5] apply_recipe(plotattributes::AbstractDict{Symbol, Any}, #unused#::Type{RecipesPipeline.SliceIt}, x::Any, y::Any, z::Any)
    @ RecipesPipeline C:\Users\Shayan\.julia\packages\RecipesBase\qpxEX\src\RecipesBase.jl:289
  [6] _process_userrecipes!(plt::Any, plotattributes::Any, args::Any)
    @ RecipesPipeline C:\Users\Shayan\.julia\packages\RecipesPipeline\OXGmH\src\user_recipe.jl:36
  [7] recipe_pipeline!(plt::Any, plotattributes::Any, args::Any)
    @ RecipesPipeline C:\Users\Shayan\.julia\packages\RecipesPipeline\OXGmH\src\RecipesPipeline.jl:70
  [8] _plot!(plt::Plots.Plot, plotattributes::Any, args::Any)
    @ Plots C:\Users\Shayan\.julia\packages\Plots\lW9ll\src\plot.jl:209
  [9] #plot#145
    @ C:\Users\Shayan\.julia\packages\Plots\lW9ll\src\plot.jl:91 [inlined]
 [10] boxplot(::Any, ::Vararg{Any}; kw::Base.Pairs{Symbol, V, Tuple{Vararg{Symbol, N}}, NamedTuple{names, T}} where {V, N, names, T<:Tuple{Vararg{Any, N}}})
    @ Plots C:\Users\Shayan\.julia\packages\RecipesBase\qpxEX\src\RecipesBase.jl:410
 [11] add_label(::Vector{String}, ::typeof(boxplot), ::Vector{String}, ::Vararg{Any}; kwargs::Base.Pairs{Symbol, Real, Tuple{Symbol, Symbol}, NamedTuple{(:fillalpha, :linewidth), Tuple{Float64, Int64}}})    @ StatsPlots C:\Users\Shayan\.julia\packages\StatsPlots\faFN5\src\df.jl:153
 [12] (::var"#33#34"{String})(349::DataFrame)
    @ Main .\none:0
 [13] BoxPlotColumn(col::String, df::DataFrame)
    @ Main c:\Users\Shayan\Documents\Python Scripts\test2.jl:15
 [14] top-level scope
    @ c:\Users\Shayan\Documents\Python Scripts\test2.jl:22

错误原因 #

@df宏的作用是将后续表达式中的字面量Symbol（比如:a）替换为DataFrame中对应的列数据。但在函数里，Symbol(col)是动态生成的Symbol，@df宏无法在宏展开阶段识别这个动态符号，也就不会将其替换为df的列数据。此时boxplot函数接收到的第二个参数是一个纯Symbol，而非列的数值数据，因此抛出“无法将Symbol转换为绘图用的系列数据”的错误。

修复方法 #

方法1：提前提取列数据，绕过@df的宏替换限制 #

直接从DataFrame中取出目标列的数据，再传入boxplot，不需要依赖@df的符号替换：

function BoxPlotColumn(col::Union{Symbol, String}, df::DataFrame)
    col_sym = Symbol(col)
    col_name = String(col_sym)
    boxplot([col_name], df[!, col_sym], fillalpha=0.75, linewidth=2)
end

方法2：利用@df的正确用法，直接引用列名 #

通过字符串插值生成列名的Symbol字面量，让@df宏可以正确识别并替换：

function BoxPlotColumn(col::Union{Symbol, String}, df::DataFrame)
    col_name = String(col)
    @df df boxplot([col_name], $col_name, fillalpha=0.75, linewidth=2)
end

这里的$col_name会在宏展开时被替换为对应的Symbol（比如:a），@df就能正常将其映射到df的列数据。

方法3：简化函数逻辑，统一处理输入类型 #

不需要分支判断，直接将输入的col转换为Symbol和字符串，代码更简洁：

function BoxPlotColumn(col::Union{Symbol, String}, df::DataFrame)
    col_sym = Symbol(col)
    boxplot([String(col_sym)], df[!, col_sym], fillalpha=0.75, linewidth=2)
end

以上三种方法都可以解决报错问题，其中方法1和3更直观，避免了宏展开的潜在问题。

内容的提问来源于stack exchange，提问作者Shayan