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

Documentation for dims keyword argument #144

Open
ElOceanografo opened this issue Jun 26, 2024 · 1 comment
Open

Documentation for dims keyword argument #144

ElOceanografo opened this issue Jun 26, 2024 · 1 comment

Comments

@ElOceanografo
Copy link

I wasn't able to find a clear description in the documentation of how to use the dims kwarg for the imputation methods. I think I was able to figure it out from context in the examples, but it would be good to have an unambiguous statement saying something like "If your dataset is in standard Table/DataFrame format (observations in rows, series in columns), use dims = X. If it is transposed, with observations in columns, use dims = Y."

@rofinn
Copy link
Member

rofinn commented Jul 14, 2024

The dims kwarg has gone through a few iterations, given the inconsistent conventions within the ecosystems we're trying to interact with. That's why we started using NamedDims.jl to label them. Glad the examples helped clarify it. If you think there's a clearer way to summarize it feel free to update the docstring https://github.com/invenia/Impute.jl/blob/master/src/imputors.jl#L94.

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