https://github.com/danielkovtun/shinyNotes
Shiny module for taking free-form notes and displaying them in a customizable UI
https://github.com/danielkovtun/shinyNotes
Last synced: 4 months ago
JSON representation
Shiny module for taking free-form notes and displaying them in a customizable UI
- Host: GitHub
- URL: https://github.com/danielkovtun/shinyNotes
- Owner: danielkovtun
- License: other
- Created: 2019-12-23T20:27:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-19T17:38:42.000Z (about 2 years ago)
- Last Synced: 2024-04-25T08:02:52.877Z (12 months ago)
- Language: R
- Homepage: https://danielkovtun.github.io/shinyNotes/
- Size: 1.01 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - danielkovtun/shinyNotes - Shiny module for taking free-form notes and displaying them in a customizable UI (R)
README
# shinyNotes
Shiny module for taking free-form notes and displaying them in a customizable UI.
The `shinyNotes` package is an enterprise-targeted scalable and customizable `shiny` module providing an easy way to incorporate free-form note taking or discussion boards into your shiny applications.
The package includes a shiny module, `shinynotes`, that can be included in any shiny application to create a panel containing searchable, editable text broken down by section headers of your choice.
## Installation
You may install the stable version from CRAN, or the development version using `devtools`:
```{r}
# install from CRAN
install.packages('shinyNotes')
# or the development version, via devtools
devtools::install_github('danielkovtun/shinyNotes')
```
## Usage
#### Demo Shiny Application
To start off, try running a demo Shiny application included with the package by running:
```{r}
library(shinyNotes)
runExample('demo')
```
#### Editing Notes
Notes can be directly modified by clicking the edit button and using the generated `textAreaInput` fields. To delete a note, simply remove all text from a `textAreaInput` and click save.
#### Adding Text Fields and Sections
You can add a new note to a section by clicking the "plus" button and selecting an existing category to add a note to. To add a new section header, fill in the inputs provided in the `modalDialog`.
#### Custom Text Formatting with Markdown
A range of markdown text formatting is supported by `shinyNotes`. In addition to vanilla markdown, you can write inline math equations that are rendered with `MathJax` and even include emojis :exclamation: :astonished:
See the full documentation at https://danielkovtun.github.io/shinyNotes/.