-
Notifications
You must be signed in to change notification settings - Fork 12
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
Improve documentation and examples in package and/or on website #35
Comments
explanation of permission parameters like |
add package version currently it only goes up to 4.20 |
documentation for internal functions: for heavy-duty scripts/operations some "power users" may want to use these functions more regularly they can be kept as 'internal' functions as I imagine most users won't need it but would be nice if they were documented + vignette/example also if there was a way to access a log of jobs based on user account that would help too |
permissions // roles examples:
etc... |
We are expanding the R package documentation website as part of a larger project to improve AI documentation. You can preview some of the changes here: This site will include vignettes as well: I will rewrite the example scripts as proper vignettes. |
|
this is a more general point re: documentation: the documentation should try to further explain ActivityInfo API concepts. like in the field schema docs, in also the main package 'references' is a bit messy right now (probably because we've combined all of the form schema functions into one place?) |
Published here: https://www.activityinfo.org/support/docs/R/index.html |
Create {pkgdown} website for documentation and vignettes (currently lying dormant in
inst/examples
folder in the Github repository)?Some of functions also require preparation in the ActivityInfo UI beforehand (setting up forms, roles, formulas, etc.) so it would be nice if documentation could also include stuff like that.
Ex. The various
permissions
/updateRole
functions took a long time for Robert and I to properly grok as the set-up includes lots of actions needed in ActivityInfo UI in tandem with what's needed in the R code to run, which is a lot of lists-within-lists for filters, parameters, etc. This is a topic that would be perfect for a vignette hosted on a pkgdown website with screenshots of the actual tables and database settings in the ActivityInfo UI alongside the R code.The text was updated successfully, but these errors were encountered: