AlgebraOfGraphics.jl icon indicating copy to clipboard operation
AlgebraOfGraphics.jl copied to clipboard

Missing dims documentation

Open nathanrboyer opened this issue 2 years ago • 1 comments

The dims function is used inside the mapping function throughout the documentation, especially in Wide Data, but I can't find an explanation of it anywhere. It should at least be listed here.

None of this was helpful either:

julia> AlgebraOfGraphics.dims(1)
AlgebraOfGraphics.DimsSelector{1}((1,))

help?> AlgebraOfGraphics.dims
  No documentation found.

  AlgebraOfGraphics.dims is a Function.

  # 1 method for generic function "dims":
  [1] dims(args...) in AlgebraOfGraphics at C:\Users\nboyer.AIP\.julia\packages\AlgebraOfGraphics\3LnVO\src\algebra\select.jl:4

help?> AlgebraOfGraphics.DimsSelector
  No documentation found.

  Summary
  ≡≡≡≡≡≡≡≡≡

  struct AlgebraOfGraphics.DimsSelector{N}

  Fields
  ≡≡≡≡≡≡≡≡

  dims :: Tuple{Vararg{Int64, N}}

help?> AlgebraOfGraphics.mapping
  No documentation found.

  AlgebraOfGraphics.mapping is a Function.

  # 1 method for generic function "mapping":
  [1] mapping(args...; kwargs...) in AlgebraOfGraphics at C:\Users\nboyer.AIP\.julia\packages\AlgebraOfGraphics\3LnVO\src\algebra\layer.jl:20

nathanrboyer avatar Aug 05 '22 15:08 nathanrboyer

For others running into this, there is pretty good documentation for dims at https://tutorials.pumas.ai/html/PlottingInJulia/06-AoG-Wide.html

ianfiske avatar Aug 07 '23 16:08 ianfiske