Merge pull request #22 from iuliadmtru/svyplot

Implement `svyplot` function with documentation and test

src/Survey.jl

@@ -13,12 +13,14 @@ include("svyby.jl")
 include("example.jl")
 include("svyglm.jl")
 include("svyhist.jl")
+include("svyplot.jl")
 
 export svydesign, svyby, svyglm
 export data, api, apiclus1, apiclus2, apipop, apistrat, apisrs
 export svymean, svytotal, svyquantile
 export @formula
 export svyhist, sturges, freedman_diaconis
+export svyplot
 export
     #families
     Normal,

src/svyplot.jl

@@ -0,0 +1,36 @@
+"""
+```
+	svyplot(design, x, y; weights, kwargs...)
+```
+Scatter plot of survey design variables `x` and `y`.
+
+Weights can be specified by a `Symbol` or an `AbstractVector` passed to the
+keyword argument `weights`.
+
+For the complete argument list see [Makie.scatter](https://makie.juliaplots.org/stable/examples/plotting_functions/scatter/index.html#scatter).
+
+```@example svyplot
+julia> using survey
+
+julia> data(api);
+
+julia> dstrat = svydesign(data = apistrat, id = :1, strata = :stype, weights = :pw, fpc = :fpc);
+
+julia> s = svyplot(dstrat, :api99, :api00; weights = :pw)
+```
+
+![](./assets/scatter.png)
+"""
+function svyplot(design::svydesign, x::Symbol, y::Symbol;
+	weights::Union{Symbol, AbstractVector} = ones(size(design.variables, 1)),
+	kwargs...
+   )
+xs = design.variables[!, x]
+ys = design.variables[!, y]
+
+if isa(weights, Symbol)
+weights = design.variables[!, weights]
+end
+
+scatter(xs, ys; markersize = weights, marker = '￮', kwargs...)
+end

test/runtests.jl

@@ -18,3 +18,4 @@ end
 
 include("svyglm.jl")
 include("svyhist.jl")
+include("svyplot.jl")

test/svyplot.jl

@@ -0,0 +1,10 @@
+using Survey
+using Test
+
+@testset "svyplot.jl" begin
+	data(api)
+	dstrat = svydesign(data = apistrat, id = :1, strata = :stype, weights = :pw, fpc = :fpc)
+	s = svyplot(dstrat, :api99, :api00; weights = :pw)
+
+	@test getindex(s.plot.markersize) == dstrat.variables[!, :pw]
+end