{"Package":"shinysurveys","Title":"Create and Deploy Surveys in 'Shiny'","Version":"0.1.2","Authors@R":"\nc(\nperson(given = \"Jonathan\",\nfamily = \"Trattner\",\nrole = c(\"aut\", \"cre\"),\nemail = \"jdt@jdtrat.com\",\ncomment = c(ORCID = \"0000-0002-1097-7603\")),\nperson(given = \"Lucy\",\nfamily = c(\"D'Agostino McGowan\"),\nrole = c(\"aut\"),\nemail = \"mcgowald@wfu.edu\"),\nperson(given = \"Paul\",\nfamily = c(\"Le Grand\"),\nrole = c(\"ctb\"),\nemail = \"ptlegrand1@gmail.com\")\n)","Description":"Easily create and deploy surveys in 'Shiny'. This package includes\na minimalistic framework similar to 'Google Forms' that allows for url-based\nuser tracking, customizable submit actions, easy survey-theming, and more.","License":"MIT + file LICENSE","Encoding":"UTF-8","LazyData":"true","RoxygenNote":"7.1.1.9000","Imports":"shiny, shinyjs, sass","Depends":"R (>= 2.10)","NeedsCompilation":"no","Packaged":"2021-02-18 03:51:29 UTC; jt","Author":"Jonathan Trattner [aut, cre] (),\nLucy D'Agostino McGowan [aut],\nPaul Le Grand [ctb]","Maintainer":"Jonathan Trattner ","Repository":"CRAN","Date/Publication":"2021-02-19 10:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/shinysurveys_0.1.2.tar.gz","jsonAuthors":[{"name":"Jonathan Trattner","email":"jdt@jdtrat.com","maintainer":true},{"name":"Lucy D'Agostino McGowan","email":"mcgowald@wfu.edu","maintainer":false},{"name":"Paul Le Grand","email":"ptlegrand1@gmail.com","maintainer":false}],"readme":"# shinysurveys\n\n#### Easily Create and Deploy Surveys in Shiny\n\n\n\n[![R-CMD-check](https://github.com/jdtrat/shinysurveys/workflows/R-CMD-check/badge.svg)](https://github.com/jdtrat/shinysurveys/actions) [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)\n\n\n\n------------------------------------------------------------------------\n\n

\n\n{shinysurveys} provides easy-to-use, minimalistic code for creating and deploying surveys in Shiny. Originally inspired by Dean Attali's [shinyforms](https://github.com/daattali/shinyforms), our package provides a framework for robust surveys, similar to Google Forms, in R with [Shiny](https://github.com/rstudio/shiny/).\n\n## Table of contents\n\n- [Installation](#installation)\n- [Demos](#demos)\n- [Getting Started](#getting-started)\n- [Advanced Surveys](#advanced-surveys)\n- [Further Reading](#further-reading)\n- [Feedback](#feedback)\n- [Code of Conduct](#code-of-conduct)\n\n------------------------------------------------------------------------\n\n## Installation\n\nYou can install the development version of shinysurveys on from Github as follows:\n\n``` {.r}\n# Install/update shinysurveys with the development version from GitHub. \n# Will install devtools if not already installed \nif (!require(\"devtools\")) install.packages(\"devtools\")\ndevtools::install_github(\"jdtrat/shinysurveys\")\n\n# Load package\nlibrary(shinysurveys)\n```\n\n## Demos\n\nA survey made with our package might look like this:\n\n![](https://www.jdtrat.com/packages/shinysurveys/resources/shinysurveys-final-demo.gif)\n\nYou can run a demo survey with the function `shinysurveys::demo_survey()`.\n\n## Getting Started\n\nAside from `demo_survey()`, {shinysurveys} exports two functions: `surveyOutput()` and `renderSurvey()`. The former goes in the UI portion of a Shiny app, and the latter goes in the server portion. To create a survey, you can build a data frame with your questions. The following columns are required.\n\n- *question*: The question to be asked.\n- *option*: A possible response to the question. In multiple choice questions, for example, this would be the possible answers. For questions without discrete answers, such as a numeric input, this would be the default option shown on the input. For text inputs, it is the placeholder value.\n- *input_type*: What type of response is expected? Currently supported types include `numeric`, `mc` for multiple choice, `text`, `select`, and `y/n` for yes/no questions.\n- *input_id*: The id for Shiny inputs.\n- *dependence*: Does this question (row) depend on another? That is, should it only appear if a different question has a specific value? This column contains the input_id of whatever question this one depends upon.\n- *dependence_value*: This column contains the specific value that the dependence question must take for this question (row) to be shown.\n- *required*: logical TRUE/FALSE signifying if a question is required. Surveys can only be submitted when all required questions are answered.\n\nOur demo survey can be created as follows:\n\n``` {.r}\nlibrary(shiny)\nlibrary(shinysurveys)\n\ndf <- data.frame(question = \"What is your favorite food?\",\n option = \"Your Answer\",\n input_type = \"text\",\n input_id = \"preferred_name\",\n dependence = NA,\n dependence_value = NA,\n required = F)\n\nui <- fluidPage(\n surveyOutput(df = df,\n survey_title = \"Hello, World!\",\n survey_description = \"Welcome! This is a demo survey showing off the {shinysurveys} package.\")\n)\n\nserver <- function(input, output, session) {\n renderSurvey(df = df)\n \n observeEvent(input$submit, {\n showModal(modalDialog(\n title = \"Congrats, you completed your first shinysurvey!\",\n \"You can customize what actions happen when a user finishes a survey using input$submit.\"\n ))\n })\n}\n\nshinyApp(ui, server)\n```\n\n## Advanced Surveys\n\n- **Dependencies** can be added so a specific question will appear based on a participant's answer to preceding questions. The `dependence` column takes an input_id of a preceding question and, if the participant answers with the value in `dependence_value`, the new question will be shown.\n\n- **Required questions** can be specified by adding the value `TRUE` to the `required` column. If a required question is not answered, the user will not be able to submit their responses.\n\n- **URL-based user tracking** functionality lets you keep track of participants easily and systematically. If you deploy your survey on [shinyapps.io](https://www.shinyapps.io/), or run it locally in a browser, you can add a URL parameter after the backslash as follows: `?user_id=UNIQUE_ID`. A live demo can be found here: https://jdtrat-apps.shinyapps.io/shinysurveys_user_tracking/?user_id=hadley\n\n## Further Reading\n\nFor a more in-depth explanation of {shinysurveys}, please see the vignette [*A survey of {shinysurveys}*](https://www.jdtrat.com/packages/shinysurveys/articles/surveying-shinysurveys.html).\n\n## Feedback\n\nIf you want to see a feature, or report a bug, please [file an issue](https://github.com/jdtrat/shinysurveys/issues) or open a [pull-request](https://github.com/jdtrat/shinysurveys/pulls)! As this package is just getting off the ground, we welcome all feedback and contributions. See our [contribution guidelines](https://github.com/jdtrat/shinysurveys/blob/main/.github/CONTRIBUTING.md) for more details on getting involved!\n\n## Code of Conduct\n\nPlease note that the shinysurveys project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.","jobInfo":{"package":"shinysurveys","version":"0.1.2","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-07-11T06:29:48+0000"}}

Description

Usage

Arguments

Value