-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathabout.qmd
99 lines (55 loc) · 4.3 KB
/
about.qmd
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
---
execute:
eval: true
echo: false
message: false
---
## What is surveydown?
**surveydown** is a flexible, open-source platform for making surveys with {{< var rproject >}}, {{< var quarto >}}, {{< var shiny >}}, and {{< var supabase >}}.
<center>
<img src='images/technologies.png' 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)"/>
</center>
<br>
Here's how it works:
1. Design your survey as a {{< var quarto >}} document using markdown and R code.
2. Render your survey into a {{< var shiny >}} app that can be hosted online and sent to respondents.
3. Store survey responses in a PostgreSQL database - we recommend {{< var supabase >}} 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 {{< var supabase >}} 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.
## Authors
The surveydown project is led by professor [John Paul Helveston](https://www.jhelvy.com/) at George Washington University and was originally developed in collaboration with his students [Pingfan Hu](https://pingfanhu.com) and [Bogdan Bunea](https://www.linkedin.com/in/bogdanbt/).
As an open-source package, surveydown now has many more contributors who have added features and improved the project over time. See the [**Contributors' Page**](https://github.com/surveydown-dev/surveydown/graphs/contributors) for details.
<br>
::: {style="display: flex; flex-wrap: wrap; gap: 2%;"}
::: {style="width: 22%;"}
{style="width: 200px; border-radius: 50%;"}
:::
::: {style="width: 76%;"}
**John Paul Helveston, Ph.D.**
[John Paul Helveston](https://www.jhelvy.com) is an Assistant Professor in the Department of Engineering Management and Systems Engineering at George Washington University. Professor Helveston is the core designer and developer, and maintainer of both the surveydown project and this documentation website.
:::
:::
::: {style="display: flex; flex-wrap: wrap; gap: 2%;"}
::: {style="width: 22%;"}
{style="width: 200px; border-radius: 50%;"}
:::
::: {style="width: 76%;"}
**Pingfan Hu**
[Pingfan Hu](https://pingfanhu.com) is a Ph.D. student in Systems Engineering at George Washington University, supervised by professor Helveston. Pingfan is mainly responsible for UI design, user interactions, and website maintenance.
:::
:::
::: {style="display: flex; flex-wrap: wrap; gap: 2%;"}
::: {style="width: 22%;"}
{style="width: 200px; border-radius: 50%;"}
:::
::: {style="width: 76%;"}
**Bogdan Bunea**
[Bogdan Bunea](https://www.linkedin.com/in/bogdanbt/) is an undergraduate student majoring in Systems Engineering and minoring in Computer Science at George Washington University. Bogdan is mainly responsible for database connection and data management.
:::
:::