cabinets

CRAN status Lifecycle: stable Travis build status Codecov test coverage

Cabinets makes it easy to create project specific file structure templates that can be referenced at the start of any R session. Cabinets works by writing project specific file templates to the .Rprofile file of the default working directory. Doing so allows the templates to be accessed in new R sessions without having to redefine them. On first use, users will be prompted for explicit permission to write to .Rprofile. Permission to write can be revoked at any time by setting the permission option in the .Rprofile file to FALSE. Due to these explicit permission requirements, cabinets will only work in interactive R sessions.

cabinets has two main functions: create_cabinet() and new_cabinet_proj(). create_cabinet() constructs an R6 object of class FileCabinet which is then written to a .Rprofile file. Whenever a fresh R session is started from the default working directory, the .Rprofile file loads the previously created cabinet for further use. FileCabinet objects simply contain a template that new_cabinate_proj() uses to build projects with defined file structures.

Installation

cabinets can be installed from CRAN using install.packages("cabinets"). The development version can be installed using devtools::install_github("nt-williams/cabinets").

But, why?

As a statistician, I work on different contracts with different standard directories.

For contract X, I might have the standard file structure:

├── data
│   ├── derived
│   └── source
├── code
├── reports
├── documents
└── log

While for contract Y, I have to work with an organization that requires I use their own system:

├── Code
│   ├── ReportsCode
│   └── AnalysisCode
├── Notes
└── Log

Cabinets results in only having to define these templates once.

Demo

Using the first project file structure described above, we define a new cabinet.

cabinet_loc <- "~/cabinet_test"

cabinet_str <- list(
    'data' = NULL, 
    'code' = NULL, 
    'data/derived' = NULL, 
    'data/source' = NULL, 
    'reports' = NULL, 
    'documents' = NULL, 
    'log' = NULL
)

create_cabinet(name = "contract_x", 
               directory = cabinet_loc, 
               structure = cabinet_str)
               
#> Permission granted.
#> Checking for .Rprofile...
#> .Rprofile not found.
#> Creating .Rprofile...
#> Checking cabinet name... 
#> Cabinet .contract_x created... Restarting R.
#> Cabinet can be called using: .contract_x
#> 
#> Restarting R session...

The cabinet is now created and doesn’t have to be redfined in future R sessions. To examine the cabinet we just call it.

.contract_x

#> Cabinet name: contract_x
#> Cabinet path: ~/cabinet_test
#> Cabinet structure: 
#> ├── data
#> │   ├── derived
#> │   └── source
#> ├── code
#> ├── reports
#> ├── documents
#> └── log

new_cabinet_proj() is used to create a new directory from a cabinet template.

new_cabinet_proj(cabinet = .contract_x, 
                 project_name = "project_1")

#> Checking cabinet existence...
#> Checking if project already exists...
#> Creating project_1 using cabinet template: .contract_x 
#> 
#> R project settings:
#> 
#> Version: 1.0
#> RestoreWorkspace: No
#> SaveWorkspace: No
#> AlwaysSaveHistory: Default
#> EnableCodeIndexing: Yes
#> UseSpacesForTab: Yes
#> NumSpacesForTab: 2
#> Encoding: UTF-8
#> RnwWeave: Sweave
#> LaTeX: pdfLaTeX
#> AutoAppendNewline: Yes
#> StripTrailingWhitespace: Yes 
#> Opening new R project, project_1
#> 
#> ✔ Opening '/Users/nickwilliams/cabinet_test/project_1/' in new RStudio session

Checking the files in the newly opened project…

list.files()
#> [1] "code"            "data"            "documents"       "log"            
#> [5] "project_1.Rproj" "reports"