boxr

:package: A high-level R interface for the box.com API

https://github.com/r-box/boxr

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 13 committers (7.7%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.8%) to scientific vocabulary

Last synced: 9 months ago · JSON representation

Repository

:package: A high-level R interface for the box.com API

Basic Info

Host: GitHub
Owner: r-box
License: other
Language: R
Default Branch: main
Homepage: https://r-box.github.io/boxr
Size: 8.86 MB

Statistics

Stars: 63
Watchers: 4
Forks: 26
Open Issues: 39
Releases: 14

Created over 11 years ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog License

README.Rmd

---
output: github_document
params:
  url_root: "https://r-box.github.io/boxr/"
---



```{r setup, echo=FALSE, message=FALSE}
library("conflicted")
library("glue")

url <- function(x = "") {
  glue::glue("{params$url_root}{x}")
}
```

# boxr 


[![cran version](https://www.r-pkg.org/badges/version/boxr)](https://CRAN.R-project.org/package=boxr)
[![codecov](https://codecov.io/gh/r-box/boxr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/covr?branch=master)
![monthly_downloads](https://cranlogs.r-pkg.org/badges/boxr)
[![R-CMD-check](https://github.com/r-box/boxr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-box/boxr/actions/workflows/R-CMD-check.yaml)


A lightweight, *opinionated*, high-level R interface to the box.com API, standing on the shoulders of **[httr](https://github.com/r-lib/httr)**.

[Box](https://www.box.com) is a cloud content-management and file-sharing service. The goal of the **boxr** package is to make it easier for you to integrate your Box account into your R workflow.

## New in boxr 0.3.7

### Bug fixes

- Harmonizes the default location for tokens; `~` resolves to the home directory for all platforms. 
  A patch is applied offering to move tokens from "old" locations. 
  This bug appeared on Windows only.
  
### Documentation  

- Updates documentation, updating some steps and adding alt-text for figures.

### Build
  
- Reduces and rationalizes package-dependencies.



All changes are detailed in the [NEWS](`r url("news/")`).

## Installation

You can install boxr from [CRAN](https://CRAN.R-project.org/package=boxr), with:

```R
install.packages("boxr")
```
 
If you'd like to install the development version from GitHub, use:

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

### Documentation

The package-documentation website is created and maintained using [pkgdown](https://pkgdown.r-lib.org). The documentation website consists of:

  - a [CRAN-version site](`r url()`).
  - a [development-version site](`r url("dev/")`).

## Usage

We have a [Get-started article](`r url("articles/boxr.html")`) that goes into more detail on interacting with your Box account using R.

### Authentication


If you have access to `client_id` and `client_secret` for a Box-app, you can use `box_auth()` to authenticate:

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

This will kick off a process that, all being well, will keep you authenticated for the rest of the R session. By saving this information to your `.Renviron` file, at your next R session you can use, without arguments:

```r
box_auth()
```

If you don't have access to `client_id` and `client_secret`, you should read the [authentication article](`r url("articles/boxr-apps.html")`) to determine your next steps. In most cases, this next step will be to create an [interactive Box-app](`r url("articles/boxr-app-interactive.html")`) 

### Basic operations

  - [Accessing Box files](`r url("articles/boxr.html#files")`): `box_ul()`, `box_dl()`, `box_version_history()`.
  - [Accessing Box directories](`r url("articles/boxr.html#directories")`): `box_setwd()`, `box_getwd()`, `box_dir_create()`, `box_ls()`, `box_search()`.
  - [Directory-wide operations](`r url("articles/boxr.html#directory-wide-operations")`): `box_push()`, `box_fetch()`.
  
### Advanced operations

  - [Interactng with Box files](`r url("articles/boxr.html#box-file-interaction")`):  `box_collab_create()`, `box_comment_create()`, `box_add_description()`.
  - [Using Box trash](`r url("articles/boxr.html#using-box-trash")`): `box_delete_file()`, `box_delete_folder()`, `box_restore_file()`, `box_restore_folder()`.
  - [Interacting with your R session](`r url("articles/boxr.html#interacting-with-your-r-session")`): `box_read()`, `box_write()`, `box_read_rds()`, `box_save_rds()`, `box_save()`, `box_load()`, `box_browse()`.

## Alternatives

Other ways to interact with a Box account include:

  - The [Box desktop apps](https://www.box.com/resources/downloads).
  - The *other* boxr, [written in Ruby](https://github.com/cburnette/boxr). Its motivations are rather different, and it covers 100% of the box.com API (e.g account administration, etc.).
  - Box themselves provide a [wide range of SDKs](https://github.com/box), including [one for Python](https://github.com/box/box-python-sdk).

## 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 addition to [NEWS.md](`r url("news/")`), and have a test or two. This project has a standard [Code of Conduct](`r url("CONDUCT.html")`).

## License

The MIT License (MIT)

Copyright (c) 2015-`r format(Sys.time(), "%Y")` 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.

Owner

Name: r-box
Login: r-box
Kind: organization

Repositories: 3
Profile: https://github.com/r-box

GitHub Events

Total

Create event: 5
Release event: 1
Issues event: 12
Delete event: 4
Issue comment event: 2
Push event: 26
Pull request event: 8
Fork event: 2

Last Year

Create event: 5
Release event: 1
Issues event: 12
Delete event: 4
Issue comment event: 2
Push event: 26
Pull request event: 8
Fork event: 2

Committers

Last synced: about 3 years ago

All Time

Total Commits: 529
Total Committers: 13
Avg Commits per committer: 40.692
Development Distribution Score (DDS): 0.206

Top Committers

Name	Email	Commits
Brendan Rocks	r**n@g**m	420
Ian Lyttle	i**e@s**m	29
Ian Lyttle	i**e@u**m	23
Brendan Rocks	b**n@b**m	21
Nate	n**y@g**m	15
Alec Wong	a**5@c**u	13
Vincent C Fulco	v**1@g**m	2
Malcolm Barrett	m**t@u**m	1
Botan Ağın	a**n@g**m	1
alexbrodersen	a**x@b**o	1
Jas Sohi	j**1@g**m	1
Romain François	r**n@p**t	1
Calum You	z**u@g**m	1

Committer Domains (Top 20 + Academic)

purrple.cat: 1 brodersen.io: 1 cornell.edu: 1 brendanrocks.com: 1 schneider-electric.com: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time

Total issues: 95
Total pull requests: 55
Average time to close issues: 5 months
Average time to close pull requests: 21 days
Total issue authors: 40
Total pull request authors: 13
Average comments per issue: 2.87
Average comments per pull request: 2.62
Merged pull requests: 43
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 7
Pull requests: 9
Average time to close issues: 5 days
Average time to close pull requests: 5 days
Issue authors: 3
Pull request authors: 2
Average comments per issue: 0.0
Average comments per pull request: 0.22
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

ijlyttle (40)
nathancday (7)
ashirwad (5)
jtraurig (3)
tamuanand (2)
alexbrodersen (2)
fmmattioni (2)
jrosen48 (2)
rrpaleja (1)
bzigterman (1)
jfunction (1)
botan (1)
JoeBradlee (1)
hshambaugh (1)
nickp60 (1)

Pull Request Authors

ijlyttle (43)
nathancday (8)
SamanthaToet (2)
tomsing1 (2)
danielruss (2)
mcdonohue (1)
malcolmbarrett (1)
Zedseayou (1)
alexbrodersen (1)
nickp60 (1)
chainsawriot (1)
botan (1)
ashirwad (1)

Top Labels

Issue Labels

enhancement (7) help wanted (6) feature request (5) wontfix (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 538 last-month
Total docker downloads: 43,390

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 10
Total maintainers: 1

cran.r-project.org: boxr

Interface for the 'Box.com API'

Homepage: https://r-box.github.io/boxr/
Documentation: http://cran.r-project.org/web/packages/boxr/boxr.pdf
License: MIT + file LICENSE
Latest release: 0.3.7
published about 1 year ago

Versions: 10
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 538 Last month
Docker Downloads: 43,390

Rankings

Docker downloads count: 0.6%

Forks count: 3.3%

Stargazers count: 5.6%

Average: 13.9%

Downloads: 21.2%

Dependent repos count: 24.0%

Dependent packages count: 28.8%

Maintainers (1)

ijlyttle@me.com

Last synced: 9 months ago

Dependencies

DESCRIPTION cran

assertthat * imports
bit64 * imports
digest * imports
dplyr * imports
fs * imports
glue * imports
httpuv * imports
httr >= 1.1.0 imports
jsonlite * imports
lifecycle * imports
magrittr * imports
mime * imports
purrr * imports
rio * imports
rlang * imports
stats * imports
stringr * imports
tibble * imports
utils * imports
clipr >= 0.3.0 suggests
conflicted * suggests
covr * suggests
gargle >= 0.3.0 suggests
here * suggests
jose * suggests
knitr * suggests
openssl * suggests
png * suggests
rmarkdown * suggests
sodium * suggests
testthat * suggests
usethis * suggests

.github/workflows/R-CMD-check.yaml actions

actions/cache v2 composite
actions/checkout v2 composite
actions/upload-artifact main composite
r-lib/actions/setup-pandoc v1 composite
r-lib/actions/setup-r v1 composite

.github/workflows/pkgdown.yaml actions

actions/cache v2 composite
actions/checkout v2 composite
r-lib/actions/setup-pandoc v1 composite
r-lib/actions/setup-r v1 composite

.github/workflows/test-coverage.yaml actions

actions/cache v2 composite
actions/checkout v2 composite
r-lib/actions/setup-pandoc v1 composite
r-lib/actions/setup-r v1 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

boxr

Science Score: 36.0%

Repository

Basic Info

Statistics

Metadata Files

README.Rmd

Owner

GitHub Events

Total

Last Year

Committers

All Time

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: boxr

Rankings

Maintainers (1)

Dependencies