{"Package":"markdownInput","Type":"Package","Title":"Shiny Module for a Markdown Input with Result Preview","Version":"0.1.2","Authors@R":"c(\nperson(\"Julien\", \"Diot\", email=\"juliendiot@ut-biomet.org\", role=c(\"aut\",\"ctb\", \"cre\"),\ncomment=c(ORCID=\"0000-0002-8738-2034\"))\n)","Maintainer":"Julien Diot ","Description":"An R-Shiny module containing a \"markdownInput\". This input allows\nthe user to write some markdown code and to preview the result. This input\nhas been inspired by the \"comment\" window of .","Imports":"shiny (>= 1.0.5), shinyAce, markdown","License":"GPL-3","Encoding":"UTF-8","LazyData":"true","URL":"https://github.com/juliendiot42/markdownInput","BugReports":"https://github.com/juliendiot42/markdownInput/issues","RoxygenNote":"7.0.2","NeedsCompilation":"no","Packaged":"2020-01-20 09:50:20 UTC; julien","Author":"Julien Diot [aut, ctb, cre] ()","Repository":"CRAN","Date/Publication":"2020-01-31 14:20:05 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/markdownInput_0.1.2.tar.gz","jsonAuthors":[{"name":"Julien Diot","email":"juliendiot@ut-biomet.org","maintainer":true}],"readme":"# Package \"markdownInput\"\nThis directory contains the \"markdownInput\" package for the R programming language. This package is a [R-Shiny module](https://shiny.rstudio.com/articles/modules.html) providing a Shiny input to write some markdown code and to preview the result. This input has been inspired by the \"comment\" window of https://github.com/.\n\n## Installation\nTo install this package, the easiest is to directly install the package from GitHub:\n\n_{In your `R` console:}\n```R\ninstall.package(\"devtools\")\ndevtools::install_github(\"juliendiot42/markdownInput\")\n```\n\nOnce the package is installed, start using it:\n\n_{In your `R` console:}\n```R\nlibrary(markdownInput)\nhelp(package=markdownInput)\n```\n\n## Example\n\nOnce you have downloaded the package, you can run an example app:\n\n_{In your `R` console:}\n```R\nmarkdownInput::runExample()\n```\n\n## Usage\n\n\n### UI\n\nIn the UI part of your app you should call the `markdownInput` function.\n\nFor example:\n```R\nui <- fluidPage(titlePanel(\"Markdown input\"),\n sidebarLayout(\n # inputs:\n sidebarPanel(\n markdownInput(\n \"mdInputID\",\n label = \"Write your text\",\n value = \"Write some _markdown_ **here:**\"\n )\n ),\n\n # outputs:\n mainPanel(\n h3(\"Raw value of the input:\"),\n verbatimTextOutput(\"rawResult\"))\n ))\n```\n\n### Server\n\nYou can access to the input's value in the server side by calling the module:\n\n```R\nserver <- function(input, output, session) {\n # myText is a reactive variable containing the raw markdown text\n myText <- callModule(moduleMarkdownInput, \"mdInputID\")\n\n # show \"myText\"\n output$rawResult <- renderPrint({\n print(myText())\n })\n}\n```\n\n## Issues\nWhen encountering a problem with the package, you can report issues on GitHub directly [here](https://github.com/juliendiot42/markdownInput/issues).\n\n\n\n## Contributing\nYou can contribute in various ways:\n\n* report an issue (online, see the above section);\n\n* suggest improvements (in the same way as issues);\n\n* propose a [pull request](https://help.github.com/articles/about-pull-requests/) (after creating a new branch).\n\n\n## Citation\nI invest some time and effort to create this package. Please cite it when using it:\n\n_{In your `R` console:}\n```R\ncitation(\"markdownInput\")\n```\nSee also `citation()` for citing R itself.\n\n## References\n\n* [shinyAce](https://CRAN.R-project.org/package=shinyAce): Vincent Nijs, Forest Fang, Trestle Technology, LLC and Jeff Allen (2019). shinyAce: Ace Editor Bindings for Shiny.\n\n* [shiny](https://CRAN.R-project.org/package=shiny): Winston Chang, Joe Cheng, JJ Allaire, Yihui Xie and Jonathan McPherson (2018). shiny: Web Application Framework for R.\n\n* [markdown](https://CRAN.R-project.org/package=markdown): JJ Allaire, Jeffrey Horner, Yihui Xie, Vicent Marti and Natacha Porte (2018). markdown: 'Markdown' Rendering for R.","jobInfo":{"package":"markdownInput","version":"0.1.2","parsingStatus":"success","parserVersion":1,"parsedAt":"2020-01-31T15:30:05+0000"}}

Description

Usage

Arguments