Repository files navigation

A lightweight,opinionated, high-level R interface to the box.com API,standing on the shoulders ofhttr.

Box is a cloud content-management andfile-sharing service. The goal of theboxr package is to make iteasier for you to integrate your Box account into your R workflow.

• Harmonizes the default location for tokens;~ resolves to the homedirectory for all platforms. A patch is applied offering to movetokens from “old” locations. This bug appeared on Windows only.

• Updates documentation, updating some steps and adding alt-text forfigures.

• Reduces and rationalizes package-dependencies.

All changes are detailed in theNEWS.

You can install boxr fromCRAN, with:

install.packages("boxr")

If you’d like to install the development version from GitHub, use:

# install.packages("devtools")devtools::install_github("r-box/boxr")

The package-documentation website is created and maintained usingpkgdown. The documentation website consistsof:

• aCRAN-version site.
• adevelopment-version site.

We have aGet-startedarticle that goes intomore detail on interacting with your Box account using R.

If you have access toclient_id andclient_secret for a Box-app, youcan usebox_auth() to authenticate:

box_auth(client_id="your_client_id",client_secret="your_client_secret")

This will kick off a process that, all being well, will keep youauthenticated for the rest of the R session. By saving this informationto your.Renviron file, at your next R session you can use, withoutarguments:

box_auth()

If you don’t have access toclient_id andclient_secret, you shouldread theauthenticationarticle todetermine your next steps. In most cases, this next step will be tocreate aninteractiveBox-app

• Accessing Boxfiles:box_ul(),box_dl(),box_version_history().
• Accessing Boxdirectories:box_setwd(),box_getwd(),box_dir_create(),box_ls(),box_search().
• Directory-wideoperations:box_push(),box_fetch().

• Interactng with Boxfiles:box_collab_create(),box_comment_create(),box_add_description().
• Using Boxtrash:box_delete_file(),box_delete_folder(),box_restore_file(),box_restore_folder().
• Interacting with your Rsession:box_read(),box_write(),box_read_rds(),box_save_rds(),box_save(),box_load(),box_browse().

Other ways to interact with a Box account include:

• TheBox desktop apps.
• Theother boxr,written inRuby. Its motivations are ratherdifferent, and it covers 100% of the box.com API (e.g accountadministration, etc.).
• Box themselves provide awide range of SDKs,includingone for Python.

Always very welcome! If you’d like to submit a pull request for a newfeature, ideally it would be documented, come with an addition toNEWS.md, and have a test or two.This project has a standardCode ofConduct.

The MIT License (MIT)

Copyright (c) 2015-2025 boxr contributors

Permission is hereby granted, free of charge, to any person obtaining acopy of this software and associated documentation files (the“Software”), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:

The above copyright notice and this permission notice shall be includedin all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESSOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANYCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THESOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.