https://github.com/jmcphers/bookmarkr

RStudio add-in to bookmark lines of R code
https://github.com/jmcphers/bookmarkr

Last synced: 4 months ago
JSON representation

RStudio add-in to bookmark lines of R code

• Host: GitHub
• URL: https://github.com/jmcphers/bookmarkr
• Owner: jmcphers
• License: mit
• Created: 2019-04-18T16:52:22.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-18T18:33:00.000Z (almost 6 years ago)
• Last Synced: 2024-08-13T07:11:02.373Z (6 months ago)
• Language: R
• Size: 104 KB
• Stars: 18
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - jmcphers/bookmarkr - RStudio add-in to bookmark lines of R code (R)

README

        

## bookmarkR 

This is a simple RStudio add-in that allows you to add markers (bookmarks) to your R code. You can view your list of bookmarks and jump to them quickly.

### Installing

Currently this package exists only on Github. You can install it as follows at the R console:

    > devtools::install_github("jmcphers/bookmarkr")

### Adding Bookmarks

After installation, you'll get a new "Add Bookmark" menu item in your Add-Ins menu.

![menu](docs/menu.png)

Click this to add a note at your current cursor position. Your collection of notes will be displayed in the *Markers* pane in RStudio.

![menu](docs/bookmarks.png)

### Keyboard shortcut

The add-in does not ship with a keyboard shortcut, but you can assign one so that it's easy to drop notes into your code quickly, without using the mouse. Here's how:

1. Click the Tools menu, then Modify Keyboard Shortcuts

2. In the list, look for "Add Bookmark"

3. Click the *Shortcut* column in the "Add Bookmark" row

4. Press your desired shortcut key (note that you can use a key sequence, too!)

### Known issues

- Bookmark line numbers can be incorrect after adding a new bookmark; adding a bookmark requires us to re-play all of the previous bookmarks, but the lines to which they refer may have moved

- Bookmarks are user scoped (should probably be project scoped?)

- Currently no way to delete a bookmark