arthur-shaw / susoapi

R interface for Survey Solutions' APIs
https://arthur-shaw.github.io/susoapi/
Other
9 stars 5 forks source link

Misleading help documentation for `get_assignments` and `show_archive` argument #25

Closed ashwinikalantri closed 2 years ago

ashwinikalantri commented 2 years ago

I am using get_assignments function with show_archive argument.

The documentation says the possible values are "true" or "false". This makes it look like a string input. The help file should indicate that it is a logical value.

The documentation also say that it will include archived assignments, which also makes it look like that show_archive = TRUE will give an output with all assignments - archived and not archived.