moj-analytical-services / s3tools

Interact with files in s3 on the Analytical Platform
8 stars 2 forks source link

read_using() documentation is incorrect #50

Open ltd-pa opened 3 years ago

ltd-pa commented 3 years ago

The documented required arguments for read_using() are FUN and path

https://rdrr.io/github/moj-analytical-services/s3tools/man/read_using.html

path is given as the argument in the example on the github README page as well:

s3tools::read_using(FUN=readr::read_csv, path = "alpha-everyone/s3tools_tests/iris_base.csv")

However, in the latest version of the function path has become s3_path and the function fails when path is supplied instead.