https://github.com/zekrom-vale/shinysqlbrowser

Set up a interactable interface for data entry with one or may SQL databses. Use an object for configuration or import one from YAML, JSON, or any other format.
https://github.com/zekrom-vale/shinysqlbrowser

bootstrap4 r shiny-apps sql tidyverse

Last synced: about 1 month ago
JSON representation

Set up a interactable interface for data entry with one or may SQL databses. Use an object for configuration or import one from YAML, JSON, or any other format.

• Host: GitHub
• URL: https://github.com/zekrom-vale/shinysqlbrowser
• Owner: zekrom-vale
• License: cc0-1.0
• Created: 2024-03-30T01:23:13.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-04-10T00:48:34.000Z (7 months ago)
• Last Synced: 2024-10-14T04:21:46.776Z (about 1 month ago)
• Topics: bootstrap4, r, shiny-apps, sql, tidyverse
• Language: R
• Homepage:
• Size: 219 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ShinySQLBrowser

A Shiny application that allows easy SQL data entry for anyone once set up with the `configuration.yaml` file or any other object from R.

There are 4 steps in setting up the application with Shiny. Installing ShinySQLBrowser, `UIContainer`, `includeUITable`, and `observeSwitch` provide ease of access wrapers.

If needed you can sill call `UITable` directly, but for that you will need to read the R/man files.

## Instalation

```r

devtools::install_github("https://github.com/zekrom-vale/ShinySQLBrowser")

library(ShinySQLBrowser)

```

## Table Generation `UIContainer(tables, opt = NULL)`

This function takes a list of tables and optionaly a configuration object for `format_default`s and advanced configuration such as HTML building.

It returns a container object containing the generated `UITables`.

### Paramater 1: `tables`

```yaml

:

  tab:

    title: 

    [value: ]

    [icon: ]

  con: 

  name: 

  id: 

  [types:

    [...]]

  opt: 

  [rows:

    :

      [width: ]

      input: 

    :

      [width: ]

      input:

        [con: ]

        table: 

        key: 

        val: 

      [...]]

    [js: ]

    [tbl: ]

    keys: 

  [...]

```

See [`config.yaml:tables`](https://github.com/zekrom-vale/ShinySQLBrowser/blob/main/examples/sqlite/config.yaml) for an example of the table data

### Paramater 2: Optional `opt`

```yaml

[format_default:

    : 

    [...]]

```

See [`config.yaml:otp`](https://github.com/zekrom-vale/ShinySQLBrowser/blob/main/examples/sqlite/config.yaml) for an example of the simple options data.  For more advanced configuration that is default to generating the HTML, see [`default.yaml`](https://github.com/zekrom-vale/ShinySQLBrowser/blob/main/inst/default.yaml).

## HTML Generation with  `includeUITable(container)`

Generates table containers HTML and dependencies.

Note that the table HTML will be generated and desposed on the fly.

Include this in the `ui` list of Shiny.

```r

container = UIContainer(tables, opt)

ui = bootstrapPage(

    theme = bslib::bs_theme(version = 4),

    includeUITable(container)

)

shinyApp(ui = ui)

```

## Server triggering on switch with: `observeSwitch(session, input, container)`

This function observes the switching of tabs and geerates or desposes the table

```r

container = UIContainer(tables, opt)

server = function(input, output, session) {

  observeSwitch(session, input, container)

  onSessionEnded(function(){

    # Recomeended to close your pools on close

    poolClose(pool)

  })

}

shinyApp(server = server)

```

## Example

See [/examples](https://github.com/zekrom-vale/ShinySQLBrowser/tree/main/examples) for more examples.

I will eventualy publish a sanitized version of the logs data.