ceff-tech / ffc_api_client

An R client for the online Functional Flows Calculator API
https://ceff-tech.github.io/ffc_api_client
9 stars 3 forks source link

Package documentation and examples #10

Open nickrsan opened 4 years ago

nickrsan commented 4 years ago

The package has some documentation, but needs quite a bit more. Might want to wait to finalize this until we actually have a set of workflows that will be stable APIs and maybe have a class that handles the work. But maybe not - the risk of the R6 class is that items are modified in-place, so we'd need to be careful that the new code doesn't break just from moving it to a class. What we could do is just manage the data together with the class and use it to chain everything together (but then we can just also keep using convenience functions).