https://github.com/wleepang/shiny-directory-input

An shiny input widget for selecting directories
https://github.com/wleepang/shiny-directory-input

r shiny shiny-applications widget

Last synced: 3 months ago
JSON representation

An shiny input widget for selecting directories

• Host: GitHub
• URL: https://github.com/wleepang/shiny-directory-input
• Owner: wleepang
• License: bsd-3-clause
• Created: 2016-01-19T02:50:37.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-03-03T21:45:46.000Z (over 3 years ago)
• Last Synced: 2024-05-16T14:19:26.299Z (6 months ago)
• Topics: r, shiny, shiny-applications, widget
• Language: R
• Size: 91.8 KB
• Stars: 47
• Watchers: 5
• Forks: 20
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-shiny-extensions - directoryInput - Shiny input widget for selecting directories. (UI Components / File Input)
• jimsghstars - wleepang/shiny-directory-input - An shiny input widget for selecting directories (R)

README

        
# directoryInput

A widget for interactive selection of directories for R Shiny Applications

![directory widget](screenshot.png)

# Application

Provides an input for users to select directories via an interactive, and os native 

dialog, rather than having to type in paths in a `textInput()`.

> **NOTE**: This is intended to only be used with _locally run_ shiny applications.  It will not work on server deployed applications because it uses OS shell calls to present a directory choosing dialog.  There is currently no way (that I'm aware) of _securely_ presenting a client side directory selection dialog from a hosted web application.

# Install the package

First install the `shiny` R-package from CRAN as it is required:

```r

install.packages('shiny')

```

Then install this package from github:

```r

devtools::install_github('wleepang/shiny-directory-input')

```

## Special Requirements

* Windows:

  * PowerShell 3 or higher

# Run the demo

Simply run the code to see the widget in action:

```r

library(shinyDirectoryInput)

shinyDirectoryInput::runDirinputExample()

```

# Use the widget

In `global.R` in your own app (create it if it doesn't already exist) add the line:

```r

library('shinyDirectoryInput')

```

### In `ui.R`:

* Add the widget

```r

directoryInput('directory', label = 'select a directory')

```

* Add the widget with a default value

```r

directoryInput('directory', label = 'select a directory', value = '~')

```

### In `server.R`:

* **Important**: Pass `session` into the server, it is used to communicate with the client-side widget

```

shinyServer(function(input, output, session) {

  # ...

}

```

* Invoke the dialog

```

path = readDirectoryInput(session, 'directory')

```

* Update the widget value

```

path = 'path/to/directory'

updateDirectoryInput(session, 'directory', value = path)

```

* Example: Observe when a user clicks the `...` button to select a new directory

```r

observeEvent(

  ignoreNULL = TRUE,

  eventExpr = {

    input$directory

  },

  handlerExpr = {

    if (input$directory > 0) {

      # condition prevents handler execution on initial app launch

      

      # launch the directory selection dialog with initial path read from the widget

      path = choose.dir(default = readDirectoryInput(session, 'directory'))

      

      # update the widget value

      updateDirectoryInput(session, 'directory', value = path)

    }

  }

)

```