-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathREADME.Rmd
127 lines (81 loc) · 4.83 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit this file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
warning = FALSE,
message = FALSE,
comment = "#>",
fig.path = "man/figures/",
fig.retina = 3
)
```
## surveydown
<!-- badges: start -->
[](https://CRAN.R-project.org/package=surveydown)
[](https://cran.r-project.org/package=surveydown)
<!-- badges: end -->
> [!IMPORTANT]
> 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)!
> [!NOTE]
> Visit our main site at [surveydown.org](https://surveydown.org) for the complete documentation and more information about surveydown.
## What is surveydown?
**surveydown** is an open-source, markdown-based platform for interactive and reproducible Surveys using [R](https://www.r-project.org/), [Quarto](https://quarto.org/), [Shiny](https://shiny.posit.co/), and PostgreSQL databases like [Supabase](https://supabase.com/).
<div align="center">
<img 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)"/>
</div>
<br>
Here's how it works:
1. Design your survey as a [Quarto](https://quarto.org/) document using markdown and R code.
2. Render your survey into a [shiny](https://shiny.posit.co/) app that can be hosted online and sent to respondents.
3. Store survey responses in a PostgreSQL database - we recommend [Supabase](https://supabase.com/) as a free, secure, and easy to use option.
The {surveydown} R package provides functions to bring this all together.
**See the [complete documentation](https://surveydown.org) to get started making your own surveydown survey!**
## Why surveydown?
Most 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:
- `survey.qmd`: A Quarto document that contains the survey content (pages, questions, etc).
- `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.).
This 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.
In 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.
## Installation
### Install R & Quarto
You need both:
- Install [R](https://CRAN.R-project.org/)
- Install [Quarto](https://quarto.org/)
We also recommend working with an IDE that has good support for R, Quarto, and Shiny.
[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).
### Install the {surveydown} R package
You can install {surveydown} from CRAN in your R console:
```{r}
#| eval: false
install.packages("surveydown")
```
or you can install the development version from [GitHub](https://github.com/surveydown-dev/surveydown):
```{r}
#| eval: false
# install.packages("pak")
pak::pak('surveydown-dev/surveydown')
```
Load the package with:
```{r}
#| eval: false
library(surveydown)
```
You can also check which version you have installed:
```{r}
#| eval: false
surveydown::sd_version()
```
## Roadmap
See 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.
## License
See the [License](https://github.com/surveydown-dev/surveydown/blob/master/LICENSE.md).
## Citation
If you use this package for in a publication, please cite it! You can get the citation by running `citation("surveydown")` in your R console:
```{r}
#| eval: false
citation("surveydown")
```