Skip to content

Commit

Permalink
switch from master to main (#268)
Browse files Browse the repository at this point in the history
  • Loading branch information
ijlyttle authored Feb 3, 2024
1 parent 80c5ad2 commit 19e6cf7
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 40 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: boxr
Type: Package
Title: Interface for the 'Box.com API'
Version: 0.3.6.9008
Version: 0.3.6.9009
Authors@R: c(
person("Brendan", "Rocks", email = "[email protected]",
role = c("aut")),
Expand Down
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

## Internal

* default branch switched from `master` to `main`. (#252)

* refactor to use withr functions to handle temp files. (#183)

* activate tests for `box_save()`, `box_load()` (#255)
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ url <- function(x = "") {

<!-- badges: start -->
[![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/master/graph/badge.svg?token=eeGrWfmg4P)](https://codecov.io/gh/r-box/boxr)
[![codecov](https://codecov.io/gh/r-box/boxr/branch/main/graph/badge.svg?token=eeGrWfmg4P)](https://codecov.io/gh/r-box/boxr)
![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)
<!-- badges: end -->
Expand Down
75 changes: 37 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

[![cran
version](https://www.r-pkg.org/badges/version/boxr)](https://CRAN.R-project.org/package=boxr)
[![R-CMD-check](https://github.com/r-box/boxr/workflows/R-CMD-check/badge.svg)](https://github.com/r-box/boxr/actions)
[![codecov](https://codecov.io/gh/r-box/boxr/branch/master/graph/badge.svg?token=eeGrWfmg4P)](https://codecov.io/gh/r-box/boxr)
[![codecov](https://codecov.io/gh/r-box/boxr/branch/main/graph/badge.svg?token=eeGrWfmg4P)](https://codecov.io/gh/r-box/boxr)
![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)
<!-- badges: end -->

A lightweight, *opinionated*, high-level R interface to the box.com API,
Expand All @@ -23,9 +23,9 @@ easier for you to integrate your Box account into your R workflow.

### 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.
- 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.

All changes are detailed in the
[NEWS](https://r-box.github.io/boxr/news/).
Expand All @@ -52,8 +52,8 @@ The package-documentation website is created and maintained using
[pkgdown](https://pkgdown.r-lib.org). The documentation website consists
of:

- a [CRAN-version site](https://r-box.github.io/boxr/).
- a [development-version site](https://r-box.github.io/boxr/dev/).
- a [CRAN-version site](https://r-box.github.io/boxr/).
- a [development-version site](https://r-box.github.io/boxr/dev/).

## Usage

Expand Down Expand Up @@ -88,44 +88,43 @@ Box-app](https://r-box.github.io/boxr/articles/boxr-app-interactive.html)

### Basic operations

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

### Advanced operations

- [Interactng with Box
files](https://r-box.github.io/boxr/articles/boxr.html#box-file-interaction):
`box_collab_create()`, `box_comment_create()`,
`box_add_description()`.
- [Using Box
trash](https://r-box.github.io/boxr/articles/boxr.html#using-box-trash):
`box_delete_file()`, `box_delete_folder()`, `box_restore_file()`,
`box_restore_folder()`.
- [Interacting with your R
session](https://r-box.github.io/boxr/articles/boxr.html#interacting-with-your-r-session):
`box_read()`, `box_write()`, `box_read_rds()`, `box_save_rds()`,
`box_save()`, `box_load()`, `box_browse()`.
- [Interactng with Box
files](https://r-box.github.io/boxr/articles/boxr.html#box-file-interaction):
`box_collab_create()`, `box_comment_create()`,
`box_add_description()`.
- [Using Box
trash](https://r-box.github.io/boxr/articles/boxr.html#using-box-trash):
`box_delete_file()`, `box_delete_folder()`, `box_restore_file()`,
`box_restore_folder()`.
- [Interacting with your R
session](https://r-box.github.io/boxr/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).
- 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

Expand All @@ -139,7 +138,7 @@ Conduct](https://r-box.github.io/boxr/CONDUCT.html).

The MIT License (MIT)

Copyright (c) 2015-2022 boxr contributors
Copyright (c) 2015-2024 boxr contributors

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
Expand Down

0 comments on commit 19e6cf7

Please sign in to comment.