How does box compare to using library() in R?

box provides explicit, scoped imports that prevent name clashes and global side effects, unlike library() which attaches names globally. This makes code more maintainable but requires adapting to a new syntax and workflow.

How to migrate an existing R project to use box modules?

Start by replacing library() calls with box::use() and refactor code into modules with @export directives. Refer to the 'Get started' vignette for guidance, but be prepared for significant rewriting in complex projects.

Can I use box with Shiny applications?

Yes, box can modularize Shiny UI and server logic, but ensure imports are handled within appropriate scopes to avoid rendering issues. Test thoroughly as some Shiny patterns might need adjustment.

Is box compatible with R Markdown documents?

box works in R Markdown, but use box::use() within code chunks and be mindful of scope limitations when rendering. It may require tweaks for documents relying on global attachments.

What are the performance costs of using box::use()?

box adds minimal overhead compared to library(), as it loads packages similarly but with additional scoping logic. For most use cases, performance impact is negligible, but benchmark for large-scale deployments.

Does box work with devtools for package development?

box focuses on modules outside packages, but it can import traditional packages. For package development, devtools might still be needed for building, while box can complement for internal modularity.

Open-Awesome

box <img class="emoji" alt="heart" src="https://cdn.jsdelivr.net/gh/qinwf/awesome-R@3c66da6e291bcc0520b1649125b0bed750896a9a/heart.png" height="20" align="absmiddle" width="20">

MITRv1.2.2

An R package for writing modular, reusable code using explicit imports and file-based modules without requiring full packages.

Visit Website GitHub

966 stars49 forks0 contributors

What is box <img class="emoji" alt="heart" src="https://cdn.jsdelivr.net/gh/qinwf/awesome-R@3c66da6e291bcc0520b1649125b0bed750896a9a/heart.png" height="20" align="absmiddle" width="20">?

box is an R package that provides a module system and import mechanism for writing more modular, reusable, and maintainable R code. It allows developers to organize code into file-based modules that can be imported without creating full R packages, and replaces R's `library()` function with an explicit, scoped import syntax that prevents name clashes and global side effects.

Target Audience

R developers and data scientists working on larger projects or reusable codebases who need better code organization, explicit dependency management, and reduced namespace pollution.

Value Proposition

Developers choose box because it brings modern software engineering practices to R, enabling explicit imports, local scope control, and easy code reuse without the overhead of creating full R packages, leading to more maintainable and less error-prone code.

Overview

Write reusable, composable and modular R code

Use Cases

Best For

Organizing large R projects into reusable, file-based modules
Replacing `library()` calls with explicit, scoped imports to avoid name clashes
Writing R functions that load packages without causing global side effects
Creating reusable code components without building full R packages
Adopting Python/JavaScript-like import patterns in R code
Improving code maintainability through explicit dependency declarations

Not Ideal For

Small, one-off data analysis scripts where the overhead of explicit imports outweighs the benefits
Projects deeply integrated with legacy R codebases that rely heavily on global `library()` calls
Teams unwilling to adopt new import syntax or retrain developers on scoped dependencies
Situations requiring direct installation from GitHub for cutting-edge development versions

Pros & Cons

Pros

File-Based Modules

Allows creating reusable modules from regular R files with simple @export directives, eliminating the need for full package development, as shown in the 'Reusable code modules' section.

Scoped Imports

box::use() restricts imports to the current scope, preventing global namespace pollution and enabling safer function encapsulation, demonstrated with the log function example.

Multi-Language Familiarity

Import syntax mirrors Python, JavaScript, and Rust, easing adoption for developers from those backgrounds, as highlighted in the 'Loading code' section.

Hierarchical Organization

Supports nested modules within directories for complex project structures, facilitating scalable code organization without package overhead.

Cons

Installation Limitations

Cannot be installed directly from GitHub, requiring CRAN or R-universe, which may hinder access to latest developments, as noted in the 'Installation' section.

Cultural Shift Required

Replaces the ubiquitous `library()` function, demanding retraining and potential codebase migration, which can be disruptive in teams accustomed to traditional R practices.

Ecosystem Compatibility Concerns

Some R packages and tools may not be optimized for box's import system, leading to integration challenges, especially with packages relying on global side effects from `library()`.

Frequently Asked Questions

Related Projects

devtools <img class="emoji" alt="heart" src="https://cdn.jsdelivr.net/gh/qinwf/awesome-R@3c66da6e291bcc0520b1649125b0bed750896a9a/heart.png" height="20" align="absmiddle" width="20">

Tools to make an R developer's life easier

Stars2,513

Forks763

Last commit1 month ago

lintr

Static Code Analysis for R

Stars1,279

Forks198

Last commit2 days ago

renv <img class="emoji" alt="heart" src="https://cdn.jsdelivr.net/gh/qinwf/awesome-R@3c66da6e291bcc0520b1649125b0bed750896a9a/heart.png" height="20" align="absmiddle" width="20">

renv: Project environments for R.

Stars1,154

Forks165