https://github.com/djnavarro/workbch

A "work bench" for light weight project tracking in R
https://github.com/djnavarro/workbch

Last synced: 4 days ago
JSON representation

A "work bench" for light weight project tracking in R

• Host: GitHub
• URL: https://github.com/djnavarro/workbch
• Owner: djnavarro
• License: other
• Created: 2019-06-30T01:05:15.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-04-23T02:24:59.000Z (about 5 years ago)
• Last Synced: 2025-04-16T09:22:51.882Z (8 days ago)
• Language: R
• Homepage: https://workbch.djnavarro.net
• Size: 18.7 MB
• Stars: 42
• Watchers: 2
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - djnavarro/workbch - A "work bench" for light weight project tracking in R (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# workbch

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![Travis build status](https://travis-ci.org/djnavarro/workbch.svg?branch=master)](https://travis-ci.org/djnavarro/workbch)

[![CRAN status](https://www.r-pkg.org/badges/version/workbch)](https://cran.r-project.org/package=workbch)

[![Codecov test coverage](https://codecov.io/gh/djnavarro/workbch/branch/master/graph/badge.svg)](https://codecov.io/gh/djnavarro/workbch?branch=master)

The workbch ("work bench") package provides simple utility functions to help the R user keep track of projects and navigate between them. The package is designed around the concept of jobs, where a job might correspond to an RStudio project, a git repository, a research project or indeed all of the above. Jobs are assumed to be stored in a single folder, but can be associated with URLs (e.g., on GitHub, Overleaf, OSF, or elsewhere). The package is intended to be used interactively, though most functions can be called programmatically.

## Installation

The workbch package has not been released on CRAN. You can install the

development version from GitHub with:

``` r

# install.packages("remotes")

remotes::install_github("djnavarro/workbch")

```

## Overview

The package consists of nine functions. Three functions are used to create, modify, and delete jobs

- `job_create()`. Create a new job

- `job_modify()`. Modify or delete an existing job

- `job_seek()`. Scans a directory recursively to find jobs

There are three functions that are useful for navigation:

- `job_open()`. Opens an RStudio project or changes working directory

- `job_openurl()`. Opens a URL associated with a job in a browser window

- `job_home()`. Returns the path to the job folder

There are three functions that are useful for keeping track of projects:

- `job_gitreport()`. Shows the git status of all jobs

- `job_glimpse()`. Shows all information stored about a job

- `job_list()`. Displays a table summarising all jobs, or a subset of them.