{"id":21743281,"url":"https://github.com/surveydown-dev/surveydown","last_synced_at":"2025-07-18T23:30:40.458Z","repository":{"id":152470246,"uuid":"623476557","full_name":"surveydown-dev/surveydown","owner":"surveydown-dev","description":"Markdown-Based, Programmable Surveys Using R, Quarto, Shiny, and PostgreSQL","archived":false,"fork":false,"pushed_at":"2025-07-09T21:41:45.000Z","size":17894,"stargazers_count":118,"open_issues_count":4,"forks_count":15,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-07-10T07:52:34.646Z","etag":null,"topics":["markdown","postgres","postgresql","quarto","r","shiny","shiny-apps","shiny-r","supabase","survey","surveys"],"latest_commit_sha":null,"homepage":"https://surveydown.org/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/surveydown-dev.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-04T12:57:54.000Z","updated_at":"2025-07-09T21:40:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"5a925c27-a8f7-4539-a14f-4109ad2814d3","html_url":"https://github.com/surveydown-dev/surveydown","commit_stats":null,"previous_names":["surveydown-dev/surveydown"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/surveydown-dev/surveydown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surveydown-dev%2Fsurveydown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surveydown-dev%2Fsurveydown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surveydown-dev%2Fsurveydown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surveydown-dev%2Fsurveydown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/surveydown-dev","download_url":"https://codeload.github.com/surveydown-dev/surveydown/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surveydown-dev%2Fsurveydown/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265853183,"owners_count":23839124,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","postgres","postgresql","quarto","r","shiny","shiny-apps","shiny-r","supabase","survey","surveys"],"created_at":"2024-11-26T07:04:01.679Z","updated_at":"2025-07-18T23:30:40.450Z","avatar_url":"https://github.com/surveydown-dev.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit this file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse   = TRUE,\n  warning    = FALSE,\n  message    = FALSE,\n  comment    = \"#\u003e\",\n  fig.path   = \"man/figures/\",\n  fig.retina = 3\n)\n```\n\n## surveydown\n\n\u003c!-- badges: start --\u003e\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/surveydown)](https://CRAN.R-project.org/package=surveydown)\n[![metacran downloads](https://cranlogs.r-pkg.org/badges/grand-total/surveydown)](https://cran.r-project.org/package=surveydown)\n[![GitHub stars](https://img.shields.io/github/stars/surveydown-dev/surveydown?style=social)](https://github.com/surveydown-dev/surveydown)\n\u003c!-- badges: end --\u003e\n\n\u003e [!IMPORTANT]\n\u003e surveydown is an early stage project under active development and may [not yet be a good fit for you](https://surveydown.org/faq.html#is-surveydown-right-for-me). If you are interested in experimenting with it, we welcome your [feedback](https://github.com/orgs/surveydown-dev/discussions)!\n\n\u003e [!NOTE] \n\u003e Visit our main site at [surveydown.org](https://surveydown.org) for the complete documentation and more information about surveydown.\n\n## What is surveydown?\n\n**surveydown** is an open-source, markdown-based platform for\nprogrammable and reproducible Surveys using\n[R](https://www.r-project.org/), [Quarto](https://quarto.org/),\n[Shiny](https://shiny.posit.co/), and PostgreSQL databases like\n[Supabase](https://supabase.com/).\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src='man/figures/technologies.svg' width=\"550px\" alt=\"image showing the three technologies used in the surveydown platform along with their logos: quarto (for designing surveys), shiny (for rendering the survey), and supabase (for storing data)\"/\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\nHere's how it works:\n\n1. Design your survey as a [Quarto](https://quarto.org/) document using markdown and R code.\n2. Render your survey into a [shiny](https://shiny.posit.co/) app that can be hosted online and sent to respondents.\n3. Store survey responses in a PostgreSQL database - we recommend [Supabase](https://supabase.com/) as a free, secure, and easy to use option.\n\nThe {surveydown} R package provides functions to bring this all together.\n\n**See the [complete documentation](https://surveydown.org) to get started making your own surveydown survey!**\n\n## Why surveydown?\n\nMost survey platforms (e.g., Google forms, Qualtrics, etc.) use graphic interfaces or spreadsheets to define survey content, making version control, collaboration, and reproducibility difficult or impossible. The surveydown package was designed to address these problems. As an open-source, markdown-based platform, all survey content is defined using **plain text** (markdown and R code) in two files:\n\n- `survey.qmd`: A Quarto document that contains the survey content (pages, questions, etc).\n- `app.R`: An R script defining a shiny app that contains global settings (libraries, database configuration, etc.) and server configuration options (e.g., conditional skipping / display, etc.).\n\nThis approach makes your survey easy to reproduce, share, and version control with common tools like Git. And since all survey data is stored in a PostgreSQL database, you have total control over where your survey data lives. We provide direct support for [Supabase](https://supabase.com/) as a free, secure, and easy to use option.\n\nIn case you're interested in the background behind the project, this [blog post](https://www.jhelvy.com/blog/2023-04-06-markdown-surveys/) provides something of an origin story. Note that the design discussed in the post is now quite outdated with what ultimately became surveydown.\n\n## Installation\n\n### Install R \u0026 Quarto\n\nYou need both: \n\n- Install [R](https://CRAN.R-project.org/)\n- Install [Quarto](https://quarto.org/)\n\nWe also recommend working with an IDE that has good support for R, Quarto, and Shiny.\n\n[RStudio](https://posit.co/products/open-source/rstudio/) is great, and we also like [VSCode](https://github.com/microsoft/vscode) and [Positron](https://github.com/posit-dev/positron).\n\n### Install the {surveydown} R package\n\nYou can install {surveydown} from CRAN in your R console:\n\n```{r}\n#| eval: false\n\ninstall.packages(\"surveydown\")\n```\n\nor you can install the development version from [GitHub](https://github.com/surveydown-dev/surveydown):\n\n```{r}\n#| eval: false\n\n# install.packages(\"pak\")\npak::pak('surveydown-dev/surveydown')\n```\n\nLoad the package with:\n\n```{r}\n#| eval: false\n\nlibrary(surveydown)\n```\n\nYou can also check which version you have installed:\n\n```{r}\n#| eval: false\n\nsurveydown::sd_version()\n```\n\n## Roadmap\n\nSee our [todo](https://github.com/surveydown-dev/todo) repo for a running list of things we're working on / have already added to the project.\n\n## License\n\nSee the [License](https://github.com/surveydown-dev/surveydown/blob/master/LICENSE.md).\n\n## Citation \n\nIf you use this package for in a publication, please cite it! You can get the citation by running `citation(\"surveydown\")` in your R console:\n\n```{r}\n#| eval: false\n \ncitation(\"surveydown\")\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurveydown-dev%2Fsurveydown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsurveydown-dev%2Fsurveydown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurveydown-dev%2Fsurveydown/lists"}