Change 'lazyLoad' behavior

DataONEorg / rdataone

R package for reading and writing data at DataONE data repositories

http://doi.org/10.5063/F1M61H5X

36 stars 19 forks source link

Closed gothub closed 3 years ago

gothub commented 3 years ago

Update the 'lazyLoad' parameter for 'getDataPackage()' and 'getDataObject()' so that:

when 'lazyLoad=T', the object will always be lazy loaded, regardless of size
when 'lazyLoad=F' and 'limit' is not specified, objects will not be lazy loaded, regardless of size
when 'lazyLoad=F' and 'limit=' is specified, objects will not be lazy loaded if they are smaller than the 'size' specified, if objects are larger than the 'size' specified, they will be lazy loaded.

mbjones commented 3 years ago

Thanks for the summary, @peter.

I agree with (1)
For (2), given that limit=1MB is the default setting, I think that limit should be applied by default if limit isn't explicitly set. That is the point of having a default. So I would change (2) to:
- when 'lazyLoad=F' and 'limit' is not specified, objects will not be lazy loaded, except that they will be lazy loaded when they exceed the default size limit of 1MB
I agree with (3)

gothub commented 3 years ago

Update in commit d11a69bb2aa70c9964945cb258eebf8e8b9ec534

Documentation changed for command line roxygen and 'upload-package' vignette. Here is an excerpt from the command line docs for '?getDataPackage':