Clean up recipe kwargs

docs/example/all_recipes.jl

@@ -87,8 +87,8 @@ savefig("recipe_pressure_alt.svg"); #md #hide
 # ![](recipe_pressure_alt.svg) #md
 
 # ## Temperature plotting
-@df procdata exptfplot(:t, :T1, :T2, nmarks=40, sampmarks=true, linealpha=0.2)
-@df procdata exptvwplot!(:t, :T3, nmarks=30, sampmarks=true, linealpha=0.2)
+@df procdata exptfplot(:t, :T1, :T2, nmarks=40, showline=true, linealpha=0.2)
+@df procdata exptvwplot!(:t, :T3, nmarks=30, showline=true, linealpha=0.2)
 savefig("recipe_temp.svg"); #md #hide
 # ![](recipe_temp.svg) #md
 
@@ -230,7 +230,7 @@ sol_rf = solve(prob, Rodas3());
 # # Plot Recipes for Solution Objects
 
 # For conventional drying, we only need to plot temperatures of the frozen layer:
-modconvtplot(sol_conv, sampmarks=true)
+modconvtplot(sol_conv, showmarks=true)
 savefig("recipe_pikal.svg"); #md #hide
 # ![](recipe_pikal.svg) #md
 
@@ -240,7 +240,7 @@ savefig("recipe_multipikal.svg") #hide
 # ![](recipe_multipikal.svg) #md
 
 # For microwave-assisted drying, we also need to plot vial wall temperatures:
-modrftplot(sol_rf, sampmarks=true)
+modrftplot(sol_rf, showmarks=true)
 savefig("recipe_rf.svg"); #md #hide
 # ![](recipe_rf.svg) #md
 

docs/example/utilities.jl

@@ -142,7 +142,7 @@ plot!(Tsh3, lw=3, label="2 ramps")
 fitdat_all = @df pd_data PrimaryDryFit(:t, (:T1[:t .< 15u"hr"],
                                     :T2[:t .< 13u"hr"],
                                     :T3[:t .< 16u"hr"]),)
-plot(fitdat_all, nmarks=30, sampmarks=true)
+plot(fitdat_all, nmarks=30, showline=true)
 
 # Note that in this plot, T1 rises after 13 hours--I have deliberately included that
 # to show what this will do in $R_p(h_d)$ space.

src/recipes.jl

@@ -7,60 +7,66 @@
     n = length(y)
     sx, sy = x[offset:step:n], y[offset:step:n]
     # add an empty series with the correct type for legend markers
+    markershape = get(plotattributes, :markershape, :auto)
     @series begin
         seriestype := :path
-        markershape --> :auto
+        markershape := markershape 
         x := [Inf]
         y := [Inf]
     end
-    # add a series for the line
-    @series begin
-        primary := false # no legend entry
-        markershape := :none # ensure no markers
-        seriestype := :path
-        seriescolor := get(plotattributes, :seriescolor, :auto)
-        x := x
-        y := y
+    # add a series for the line, if it's not turned off
+    if haskey(plotattributes, :linewidth) && plotattributes[:linewidth] != :auto && plotattributes[:linewidth] > 0
+        @series begin
+            primary := false # no legend entry
+            markershape := :none # ensure no markers
+            seriestype := :path
+            x := x
+            y := y
+        end
+    end
+    # add a series for the sampled markers, if they aren't turned off
+    if markershape ∉ (:none, nothing)
+        @series begin
+            primary := false
+            seriestype := :scatter
+            markershape := markershape
+            x := sx
+            y := sy
+        end
     end
-    # return  a series for the sampled markers
-    primary := false
-    seriestype := :scatter
-    markershape --> :auto
-    x := sx
-    y := sy
 end
 
 const nmarks_doc = """
 `nmarks` is an integer, indicating how many points to plot with markers, so that the number
-of markers is reasonable even with many data points. To plot all points (default), pass `nmarks=0`.
+of markers is reasonable even with many data points. To plot all points (default), pass `nmarks=Inf`.
 
 """
-const sampmarks_marker_doc = """
-`sampmarks=false` (default) will only show markers at selected points, while `sampmarks=true` will put a line through all points.
+const showline_doc = """
+This recipe defaults to showing data points without a line, but a line can be added by passing `showline=true` or specifying a `linewidth` (or `lw`).
 
 """
-const sampmarks_line_doc = """
-`sampmarks=false` (default) will only put a line through all points, while `sampmarks=true` will show markers at selected points.
+const showmarks_doc = """
+This recipe defaults to showing a line with no markers, but a line can be added by passing `showmarks=true` or specifying a `markershape` (or `ms`).
 
 """
 
 """
-    exptfplot(time, T1, [T2, ...]; nmarks=0, labsuffix=", exp.")
-    exptfplot!(time, T1, [T2, ...]; nmarks=0, labsuffix=", exp.")
+    exptfplot(time, T1, [T2, ...]; nmarks=Inf, showline=false, labsuffix=", exp.")
+    exptfplot!(time, T1, [T2, ...]; nmarks=Inf, showline=false, labsuffix=", exp.")
 
 Plot recipe for one or more experimentally measured product temperatures, all at same times.
 This recipe adds one series for each passed temperature series, with labels defaulting to `"T_{fi}"*labsuffix`.
 
 $nmarks_doc 
-$sampmarks_marker_doc
+$showline_doc
 """ 
 exptfplot
 @doc (@doc exptfplot) exptfplot!
 
 @userplot ExpTfPlot
-@recipe function f(tpe::ExpTfPlot; nmarks=0, sampmarks=false, labsuffix = ", exp.")
+@recipe function f(tpe::ExpTfPlot; nmarks=Inf, showline=false, labsuffix = ", exp.")
     time, Ts... = tpe.args
-    step = (nmarks == 0) ? 1 : (maximum([length(T) for T in Ts]) ÷ nmarks) 
+    step = (nmarks == Inf) ? 1 : (maximum([length(T) for T in Ts]) ÷ nmarks) 
     n = size(Ts, 1)
     # pal = palette(:Blues_5,)[end:-1:begin] # Requires Plots for palette, so hard-code this default
     pal = [RGB{Float64}(0.031,0.318,0.612), 
@@ -79,7 +85,7 @@ exptfplot
             markershape --> markers[i]
             label --> labels[i]
             seriescolor --> pal[i]
-            if sampmarks
+            if showline || get(plotattributes, :linewidth, 0) > 0
                 seriestype := :samplemarkers
                 step := step
                 offset := step÷n *(i-1) + 1
@@ -97,22 +103,22 @@ end
 
 
 """
-    exptvwplot(time, T1, [T2, ...]; skip=1, nmarks=0, labsuffix=", exp.")
-    exptvwplot!(time, T1, [T2, ...]; skip=1, nmarks=0, labsuffix=", exp.")
+    exptvwplot(time, T1, [T2, ...]; skip=1, nmarks=Inf, showline=false, labsuffix=", exp.")
+    exptvwplot!(time, T1, [T2, ...]; skip=1, nmarks=Inf, showline=false, labsuffix=", exp.")
 
 Plot recipe for a set of experimentally measured vial wall temperatures.
 This recipe adds one series for each passed temperature series, with labels defaulting to `"T_{vwi}"*labsuffix`.
 `skip` is an integer, indicating how many points to skip at a time, so that 
 the dotted line looks dotted even with noisy data.
 
 $nmarks_doc
-$sampmarks_marker_doc
+$showline_doc
 """
 exptvwplot
 @doc (@doc exptvwplot) exptvwplot!
 
 @userplot ExpTvwPlot
-@recipe function f(tpev::ExpTvwPlot; nmarks=0, sampmarks=false, skip=1, labsuffix=", exp.")
+@recipe function f(tpev::ExpTvwPlot; nmarks=Inf, showline=false, skip=1, labsuffix=", exp.")
     time, Ts... = tpev.args
     n = size(Ts, 1)
     # color = palette(:Blues_5)[end]
@@ -136,19 +142,19 @@ exptvwplot
             markercolor --> :white
             markerstrokecolor --> pal[i]
             markerstrokewidth --> 1.5
-            if sampmarks
+            minlen = min(length(time), length(T))
+            if showline || get(plotattributes, :linewidth, 0) > 0
                 linestyle --> :dash
-                time_skip = time[begin:skip:end]
-                T_skip = T[begin:skip:end]
+                time_skip = time[begin:skip:minlen]
+                T_skip = T[begin:skip:minlen]
                 seriestype := :samplemarkers
-                step = (nmarks == 0) ? 1 : (size(time_skip, 1) ÷ nmarks) 
+                step = (nmarks == Inf) ? 1 : (size(time_skip, 1) ÷ nmarks) 
                 step := step
                 offset := step÷n *(i-1) + 1
                 return time_skip, T_skip
             else
-                minlen = min(length(time), length(T))
                 seriestype --> :scatter
-                step = nmarks == 0 ? 1 : (size(time, 1) ÷ nmarks) 
+                step = nmarks == Inf ? 1 : (size(time, 1) ÷ nmarks) 
                 offset = step÷n *(i-1) + 1
                 return time[offset:step:minlen], T[offset:step:minlen]
             end
@@ -158,42 +164,43 @@ exptvwplot
 end
 
 """
-    modconvtplot(sols; sampmarks=false, labsuffix = ", model")
-    modconvtplot!(sols; sampmarks=false, labsuffix = ", model")
+    modconvtplot(sols; showmarks=false, labsuffix = ", model")
+    modconvtplot!(sols; showmarks=false, labsuffix = ", model")
 
 Plot recipe for one or multiple solutions to the Pikal model, e.g. the output of [`gen_sol_pd`](@ref LyoPronto.gen_sol_pd).
 This adds a series to the plot for each passed solution, with labels defaulting to `"T_{fi}"*labsuffix`.
 
-$sampmarks_line_doc
+$showmarks_doc
 """ 
 modconvtplot
 @doc (@doc modconvtplot) modconvtplot!
 
 
 @userplot ModConvTPlot
-@recipe function f(tpmc::ModConvTPlot; sampmarks=false, labsuffix = ", model")
+@recipe function f(tpmc::ModConvTPlot; showmarks=false, labsuffix = ", model")
     sols = tpmc.args
     # pal = palette(:Oranges_4).colors[end:-1:begin+1] # Requires Plots as dependency...
     pal = [
     RGB{Float64}(0.851,0.278,0.004)
     RGB{Float64}(0.992,0.553,0.235)
     RGB{Float64}(0.992,0.745,0.522)
     ]
-    markers = (:utriangle, :dtriangle, :cross)
+    showmarks = showmarks || get(plotattributes, :markershape, :none) != :none
     if length(sols) == 1
         labels = ["\$T_\\mathrm{f}\$"*labsuffix]
     else
         labels = ["\$T_\\mathrm{f$i}\$"*labsuffix for i in 1:length(sols)]
     end
 
-    if sampmarks 
+    if showmarks 
         for (i, sol) in enumerate(sols)
             t_nd = range(sol.t[begin], sol.t[end], length=101)
             time = t_nd*u"hr"
             T = sol.(t_nd, idxs=2)*u"K"
             @series begin
                 seriestype := :samplemarkers
                 step := 20
+                offset = 10*(i-1)+1
                 markershape --> :auto
                 seriescolor --> pal[i]
                 label --> labels[i]
@@ -215,8 +222,8 @@ modconvtplot
 end
 
 """
-    modrftplot(sol, labsuffix=", model", sampmarks=false, trimend=0)
-    modrftplot!(sol, labsuffix=", model", sampmarks=false, trimend=0)
+    modrftplot(sol, labsuffix=", model", showmarks=false, trimend=0)
+    modrftplot!(sol, labsuffix=", model", showmarks=false, trimend=0)
 
 Plot recipe for one solution to the lumped capacitance model.
 
@@ -226,15 +233,16 @@ The optional argument `trimend` controls how many time points to trim from the e
 
 Since this is a recipe, any Plots.jl keyword arguments can be passed to modify the plot.
 
-$sampmarks_line_doc
+$showmarks_doc
 """
 modrftplot
 @doc (@doc modrftplot) modrftplot!
 
 @userplot ModRFTPlot
-@recipe function f(tpmr::ModRFTPlot; labsuffix = ", model", sampmarks=false, trimend=0)
+@recipe function f(tpmr::ModRFTPlot; showmarks=false, labsuffix = ", model", trimend=0)
     sol = tpmr.args[1]
-    if sampmarks
+    showmarks = showmarks || get(plotattributes, :markershape, :none) != :none
+    if showmarks
         t_nd = range(sol.t[begin], sol.t[end-trimend], length=31)
         step = 6
     else
@@ -244,7 +252,7 @@ modrftplot
     # color = palette(:Oranges_3)[end]
     color = RGB{Float64}(0.902,0.333,0.051)
     # Frozen temperature: tends to have a crazy time point at end
-    if sampmarks
+    if showmarks
         @series begin
             seriestype := :samplemarkers
             step := step