Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing dims documentation #420

Open
nathanrboyer opened this issue Aug 5, 2022 · 1 comment
Open

Missing dims documentation #420

nathanrboyer opened this issue Aug 5, 2022 · 1 comment

Comments

@nathanrboyer
Copy link
Contributor

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
@ianfiske
Copy link

ianfiske commented Aug 7, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants