Skip to content
📦 A high-level R interface for the box.com API
Branch: master
Clone or download
ijlyttle Add logo, thanks @nathancday! (addresses #92)
* Adds log, thanks @nathancday!

* Add favicons
Latest commit d220622 Mar 29, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R Change links to refer to r-box organization (#101) Mar 29, 2019
man Add logo, thanks @nathancday! (addresses #92) Mar 29, 2019
pkgdown Add logo, thanks @nathancday! (addresses #92) Mar 29, 2019
tests Update pkgdown (#94) Feb 23, 2019
vignettes Add logo, thanks @nathancday! (addresses #92) Mar 29, 2019
.Rbuildignore Change links to refer to r-box organization (#101) Mar 29, 2019
.gitignore [WIP] Update documentation (#95) Mar 29, 2019
.travis.yml
CONDUCT.md [WIP] Update documentation (#95) Mar 29, 2019
DESCRIPTION Change links to refer to r-box organization (#101) Mar 29, 2019
LICENSE
NAMESPACE documented using roxygenize Jun 17, 2018
NEWS.md Add logo, thanks @nathancday! (addresses #92) Mar 29, 2019
README.Rmd Add logo, thanks @nathancday! (addresses #92) Mar 29, 2019
README.md
appveyor.yml [CI] Only test the 'master' branch Jan 12, 2016
boxr.Rproj Local tests only, for now Mar 7, 2015
cran-comments.md [CRAN] Uncommitted changes for last release Feb 5, 2017

README.md

Build Status Win Build Status Project Status: Active - The project has reached a stable, usable state and is being actively developed. cran version monthly_downloads

boxr

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

Box is a cloud content-management and file-sharing service. The goal of the boxr package is to make it easier for you to conduct data analyses that interact with your Box account.

Installation

You can download boxr from CRAN, with:

install.packages("boxr")

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

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

Documentation

The packge-documentation website is created and maintained using pkgdown. Upon the CRAN release for version 0.3.5, the documentation website will consist of:

Until the CRAN release for version 3.5, the most-current version of the site will be the development-version site.

Usage

We have a Get-started article that goes into more detail on interacting with your Box account using R.

Authorization

This can be the a little tricky to set up, but once it works, going forward, it should just work. As detailed in the article, there are two use-cases:

  • authorizing from R your local computer
  • authorizing from R on a remote server

Once you have made the configuration, you can use box_auth() to renew your authorization for your R session.

Basic operations

Advanced operations

Alternatives

Other ways to interact with a Box account include:

Contributing

Always very welcome! If you’d like to submit a pull request for a new feature, ideally it would be documented, come with an addtion to NEWS.md, and have a test or two. This project has a standard Code of Conduct.

License

The MIT License (MIT)

Copyright (c) 2015-2019 boxr contributors

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

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

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

You can’t perform that action at this time.