https://github.com/tzerk/projbrowser

A simple RStudio addin to browse project files
https://github.com/tzerk/projbrowser

Last synced: 9 days ago
JSON representation

A simple RStudio addin to browse project files

• Host: GitHub
• URL: https://github.com/tzerk/projbrowser
• Owner: tzerk
• License: gpl-3.0
• Created: 2016-05-10T08:11:41.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-09-20T09:44:29.000Z (over 2 years ago)
• Last Synced: 2024-11-08T10:54:19.532Z (2 months ago)
• Language: R
• Size: 180 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

)

``` 

# projBrowser 

[![Build status](https://ci.appveyor.com/api/projects/status/3uyec49gu0j7ul64?svg=true)](https://ci.appveyor.com/project/tzerk/projbrowser)

[![Build Status](https://travis-ci.org/tzerk/projBrowser.svg?branch=master)](https://travis-ci.org/tzerk/projBrowser)

> [Find a full documentation of the package on the project page](https://tzerk.github.io/projBrowser/)

## Overview

`projBrowser` is a simple [RStudio Addin](http://rstudio.github.io/rstudioaddins/) that facilitates the management of [RStudio Projects](https://support.rstudio.com/hc/en-us/articles/200526207-Using-Projects).

## Requirements

[RStudio Desktop](https://www.rstudio.com/products/rstudio/download/) ≥ 0.99.896

## Installation

This package can be installed directly from GitHub via the [`devtools`](https://cran.r-project.org/web/packages/devtools/index.html) package:

```{r, eval = FALSE}

if(!require("devtools"))

  install.packages("devtools")

devtools::install_github("tzerk/projBrowser")

```

## Usage

The RStudio IDE automatically registers all available addins on startup. Once the package has been installed you should see the Addins toolbar menu populated with the addins exported by this package:

![AddinPane](man/figures/README-addin.png)

For easier access I recommend adding a keyboard shortcut for the addin (e.g., `Ctrl+Alt+P` as shown in the image). Keyboard shortcuts can be added or modified under `Addins >> Browse Addins >> Keyboard Shortcuts`.

## Note

In order to keep track of available RStudio projects this addin automatically creates a file in the package's library folder (`~/.../projBrowser/proj/projects.txt`).

This addin was developed and tested on Windows only and hence cannot guarantee that it works on Linux or Mac OS. 

## Gallery

![layout](man/figures/README-menu.png)

## License

The `projBrowser` package is licensed under the GPLv3. See these files in the main directory for additional details:

LICENSE - projBrowser package license (GPLv3)