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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #25

Closed
jorainer opened this issue Jan 28, 2025 · 2 comments
Closed

Improve documentation #25

jorainer opened this issue Jan 28, 2025 · 2 comments
Labels
hackathon

Comments

@jorainer
Copy link
Member

There is always need to improve the documentation (i.e. the roxygen documentation within the R source files) and improve/expand the package vignette.
@jorainer
Copy link
Member Author

jorainer commented Feb 5, 2025

Quick update: that's ongoing, with fixes and extensions of existing documentation and adding new documentations/documents providing better installation information and tests for different settings.

@jorainer
Copy link
Member Author

jorainer commented Feb 6, 2025

Closing this issue now. We added fixes, expanded the documentation (improving specifically the installation instructions) and added several quarto documents to inst/doc explaining installation and use in various use cases.

@jorainer jorainer closed this as completed Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
hackathon
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jorainer