Releases: r-box/boxr
boxr 0.3.6
Improvements
-
adds
vignette("design")
to sketch out the different design philosohies that appear in boxr functions. (#170) -
deprecates the
x
argument tobox_write()
in favor ofobject
. (#187) -
some return objects can be printed as tibble (vs. data-frame). To enable this behavior, set
options(boxr.print_tibble = TRUE)
(perhaps in your.Rprofile
). -
new tools to manage collaborations:
box_dir_invite()
is deprecated in favor ofbox_collab_create()
.- adds
box_collab_create()
, which supports file and group based collaborations. - also adds
box_collab_get()
to check existing collaborations, andbox_collab_delete()
to delete. box_collab_create()
andbox_collab_get()
each return the (list-based) response from the Box API.
If you prefer to work with data frames, these return-objects each haveas.data.frame()
andas_tibble()
methods.
-
box_previous_versions()
is superseded in favor ofbox_version_history()
:- returns a data frame that includes columns
version_no
(numeric) andversion_id
, rather thanversion
(character) andfile_version_id
. - exports an internal function
box_version_api()
, if you are interested in the unparsed content of the response from the API.
- returns a data frame that includes columns
-
new function
box_version_number()
returns the current version of a file; this number is consistent with theversion_no
argument used by functions such asbox_dl()
. -
new functions
box_read_rds()
andbox_save_rds()
to work withRDS
files directly on Box. -
new function
box_browse()
to open a browser window directly to a given folder or file on Box's web app. -
new functions
box_comment_create()
andbox_comment_get()
to create or get comments on Box files. These functions return specially classedlists
of the API response, on which you can useas.data.frame()
oras_tibble()
. -
uses
httr::RETRY()
for API requests to handle momentary issues with network connectivity. Thanks @jameslamb and @chircollab! -
box_ls()
provides the currentversion_id
by default. (#185, @alexbrodersen)
Bug Fixes
-
box_file_delete()
andbox_folder_delete()
each now returninvisible(NULL)
. (#197) -
box_auth_service()
more resilient to bad-request failures. (#166) -
box_auth()
longer throws error if {usethis} not installed. (#168, @malcombarret) -
...
is now passed towrite_fun
inbox_write()
. (#144) -
box_ls()
is more robust for remote folders that contain links. (#140) -
box_previous_versions()
fixed for "no-previous-versions" case. (#139)
boxr 0.3.5
Improvements
-
adds automatic-retry to authentication functions,
box_auth()
andbox_auth_service()
. (#131) -
adds
box_auth_service()
to support OAuth2.0 using JWT, also addsbox_dir_invite()
to invite a collaboration on a Box folder. This makes it easier to authenticate to box.com from remote computers (e.g. RStudio Cloud, RStudio Server) (#23) -
modifies
box_source()
: adds...
argument to pass other arguments tosource()
. -
modifies
box_write()
,box_dl()
:- deprecates the
filename
argument in favor offile_name
.
- deprecates the
-
modifies
box_auth()
(#96):- deprecates
write.Renv
argument - copies text to the clipboard, rather than overwrite the
.Renviron
file - returns
invisible(NULL)
upon success
- deprecates
-
deprecates
box_auth_on_attach()
(#96) -
adds a logo (#92, @nathancday)
-
converts pagination method from offset to marker-based paging (#79, @awong234)
-
adds option to return specified
fields
inbox_ls()
(#72, @awong234) -
adds updated screen shots (pngs in
images/
) and description for creating a Box App with the new Box Developer Console UI. Also added reference forbox_auth_on_attach
in step 4 'And you're done'. (#57, @nathancday)
Bug Fixes
boxr v0.3.3
Minor Improvements
box_push
'signore.dots
parameter now includes directories (65acef7)- Broader validation that users are correctly authenticated (47b16b5)
- Minor improvements to S3 classes (9a64aa0)
- More prominent troubleshooting section in README (8ccdaa5)
- Updated author email address (a23acc0)
Big fixes
- box.com API changes had made the ordering in
box_previous_versions
unreliable (693f5a2)
boxr v0.3.2
Minor Improvements
This release contains some minor changes for compatibility with httr v1.1.0
(boxr's major dependency).
- Some code to work around bugs in the previous versions of
httr
has been removed - Some minor tweaks for compatibility (mainly changes in reporting http status codes)
boxr v0.3.1
New Features
box_search
(and convenience functionsbox_search_files
,box_search_folders
,box_search_trash
) allow use of box.com's superb searching facilities to find files and folders. Various parameters can be set to search filenames, file contents, and to limit searches to certain file types. Results are summarised by default, can be coerced viaas.data.frame
. They can also be passed in place of a file_id to other boxr functions (e.g.box_dl
) to perform an operation on the first result.box_read_excel
Finally support for everyone else's favorite way to store data!box_write
A convenience function to convert R objects to common file types (e.g. .json, .csv, .tsv, .xlsx, etc.), and upload to box. Using the default write function (rio::export), the file type can be determined automatically from the filename provided.box_add_description
A simple way to add a description to a file on box.com. These are a useful way to decribe the contents of a file, and can also be used like commit messages on GitHub, to describe recent changes made.box_fresh_auth
A convenience function for users having trouble authenticating -- it will delete existing tokens (which are by default hidden files) for a fresh authentication process- S3 classes for files, folders, and object lists
- Objects of class
boxr_object_list
can be passed directly to functions in place of a file_id string - Objects of class
boxr_object_list
now have anas.data.frame
method
Improvements
- Example of usage with
magrittr
pipes is added to the README - box file/folder id's are now validated locally before requests are sent
- Filenames are now validated locally, with helpful/informative error mesages
box_read
now accepts a user specified read function, which is now by defaultrio::import
box_read
will now try and do the right thing for files without an extension by considering the MIME type of the API response- S3 classes and methods have been consolidated into three basic types, and functions now use them in a consistent manner. Now documented for those interested (
?boxr_S3_classes
) - Print methods: Prettier and more informative
box_getwd
no longer logs an uninformative message- Documentation / collaboration improvements (improved function documentation, variable naming conventions, and a code of conduct)
- Improved tests
Bug Fixes
options(boxr.progress = TRUE)
is now respected consistently- Fix for spurious warnings comming from the latest version of
httr
(see jeroen/curl#30 and r-lib/httr#252) - Fix for weird reporting for certain valid API queries, which return exactly 0 results
boxr v0.2.9
Note: Skipped a version increment for CRAN iterations
Bug Fixes
- Namespace stuff for the latest Rbuild under Windows
Installtion
Now up on CRAN:
install.packages("boxr")
boxr v0.2.7
Bug Fixes
- Fixed broken link for image assets in vignette
Minor Improvements
- The default OAuth2.0 token cache is now
~/.boxr-oauth
boxr v0.2.6
This release contains small changes to help new users get started (especially those who don't get to see the GitHub README).
Minor Improvements
- The package vignette (
vignette("boxr")
) is now more oriented towards getting new users up and running (fc931cd), providing much of the same information as at?box_auth
, but with screenshots and friendlier formatting - Upon loading boxr, users are now provided with the GitHub issues URL for bug reports. If it looks like the user hasn't used boxr before (
!file.exists("~/.boxr_oauth")
), the code to generate the Getting Started vignette is presented (e18864d) - R help 'homepage':
?boxr
now takes the user to a summary of the package, which links back to the Getting Started vignette (#31) - Continuous integration now covers Windows via appveyor (08925e5), and for useRs coming from GitHub, there's a few more visual aids in the README to help them evaluate/grok the package (1c574c2, 593101d, 670487b)
Installation
boxr v0.2.6 is on CRAN, the following will do the trick:
install.packages("boxr")
boxr v0.2.5
CRAN Release
Bug Fixes
- json is now parsed consistently by
box_read()
andbox_read_json()
box_getwd()
andbox_setwd()
now write to the correct options vars (e.g., work properly again) (#27)
Minor Changes
boxr v0.2.0
New Features
- Several new wrapper functions for
box_read
have been added (#25):box_read_csv
box_read_tsv
box_read_json
box_previous_versions
allows you to query previous versions of a filebox_dl
can now download specific versions of a file, via either theversion_no
orversion_id
parameter (#21)
Minor Changes
- URLs for the set-up process now point to https://www.box.com/developers/services, as opposed to https://www.box.com/developers/services (#20)