Skip to content

Commit

Permalink
removed most vignettes (moved to main doc website)
Browse files Browse the repository at this point in the history
  • Loading branch information
jhelvy committed Aug 19, 2024
1 parent a94cb27 commit 6ea82f8
Show file tree
Hide file tree
Showing 41 changed files with 23 additions and 1,396 deletions.
18 changes: 4 additions & 14 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ knitr::opts_chunk$set(
)
```

# surveydown <a href='https://jhelvy.github.io/surveydown/'><img src='man/figures/logo.png' align="right" style="width: 120px;" alt="surveydown package logo: a hex shape with a large letter S and a down arrow"/></a>
# surveydown <a href='https://surveydown.org/'><img src='man/figures/logo.png' align="right" style="width: 120px;" alt="surveydown package logo: a hex shape with a large letter S and a down arrow"/></a>

### Markdown-Based Surveys With [Quarto Shiny Documents](https://quarto.org/docs/dashboards/interactivity/shiny-r.html).

> Note: This is still a very early-stage project. We don't yet recommend using it for collecting data, but we would love any feedback you have if you try it out!
> Note: This is still an early-stage project. Use with caution, and please give us feedback!
This project brings together three open source technologies ([Quarto](https://quarto.org/), [shiny](https://shiny.posit.co/), and [supabase](https://supabase.com/)) to create dynamic, markdown-based surveys. Here's the basic concept:

Expand All @@ -35,7 +35,7 @@ This project brings together three open source technologies ([Quarto](https://qu

The {surveydown} R package works in tandem with our [surveydown Quarto extension](https://github.com/jhelvy/surveydown-ext) to make everything work.

**See the [documentation](https://jhelvy.github.io/surveydown/articles/surveydown.html) to get started making your own surveydown survey!**
**See the [documentation](https://surveydown.org) to get started making your own surveydown survey!**

# Background & Motivation

Expand Down Expand Up @@ -79,22 +79,12 @@ This is a running list of things we're working on adding to the project:
- [ ] Matrix
- [?] Slider

Resources / examples:
Resources / other related examples:

- [shinysurveys](https://github.com/jdtrat/shinysurveys)
- [shinyforms](https://github.com/daattali/shinyforms)
- [Example](https://rtask.thinkr.fr/pimping-your-shiny-app-with-a-javascript-library-an-example-using-sweetalert2/) of adding JS modules to shiny app (pop up message) - could be useful for adding any number of JS-based features, like pop ups for required questions, JS-based progress bar, etc.

# Documentation TODO

Vignettes for each of the following:

- [x] Quick overview / basic usage
- [x] List of question types and examples
- [x] Question formatting options
- [x] Flow control (conditional skipping and conditional display)
- [x] Setting up the database with supabase

## [License Information](https://github.com/jhelvy/surveydown/blob/master/LICENSE.md)

## Citation Information
Expand Down
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# surveydown <a href='https://jhelvy.github.io/surveydown/'><img src='man/figures/logo.png' align="right" style="width: 120px;" alt="surveydown package logo: a hex shape with a large letter S and a down arrow"/></a>
# surveydown <a href='https://surveydown.org/'><img src='man/figures/logo.png' align="right" style="width: 120px;" alt="surveydown package logo: a hex shape with a large letter S and a down arrow"/></a>

### Markdown-Based Surveys With [Quarto Shiny Documents](https://quarto.org/docs/dashboards/interactivity/shiny-r.html).

> Note: This is still a very early-stage project. We don’t yet recommend
> using it for collecting data, but we would love any feedback you have
> if you try it out!
> Note: This is still an early-stage project. Use with caution, and
> please give us feedback!
This project brings together three open source technologies
([Quarto](https://quarto.org/), [shiny](https://shiny.posit.co/), and
Expand All @@ -33,9 +32,8 @@ The {surveydown} R package works in tandem with our [surveydown Quarto
extension](https://github.com/jhelvy/surveydown-ext) to make everything
work.

**See the
[documentation](https://jhelvy.github.io/surveydown/articles/surveydown.html)
to get started making your own surveydown survey!**
**See the [documentation](https://surveydown.org) to get started making
your own surveydown survey!**

# Background & Motivation

Expand Down Expand Up @@ -113,7 +111,7 @@ This is a running list of things we’re working on adding to the project:
- [ ] Matrix
- \[?\] Slider

Resources / examples:
Resources / other related examples:

- [shinysurveys](https://github.com/jdtrat/shinysurveys)
- [shinyforms](https://github.com/daattali/shinyforms)
Expand All @@ -122,16 +120,6 @@ Resources / examples:
for adding any number of JS-based features, like pop ups for required
questions, JS-based progress bar, etc.

# Documentation TODO

Vignettes for each of the following:

- [x] Quick overview / basic usage
- [x] List of question types and examples
- [x] Question formatting options
- [x] Flow control (conditional skipping and conditional display)
- [x] Setting up the database with supabase

## [License Information](https://github.com/jhelvy/surveydown/blob/master/LICENSE.md)

## Citation Information
Expand Down
17 changes: 2 additions & 15 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
url: https://jhelvy.github.io/surveydown/
url: https://surveydown.org/

home:
title: Build markdown-based surveys with quarto shiny documents
Expand All @@ -13,22 +13,9 @@ template:
danger: "#A6081A"
opengraph:
image:
src: https://jhelvy.github.io/surveydown/reference/figures/logo.png
src: https://pkg.surveydown.org/reference/figures/logo.png
alt: "Logo for the surveydown package"

articles:
- title: surveydown
navbar: ~
contents:
- install
- content
- questions
- formatting
- password
- config
- database
- deploy

reference:
- title: Survey Setup
- subtitle: Functions for setting up and creating surveys
Expand Down
201 changes: 0 additions & 201 deletions vignettes/config.Rmd

This file was deleted.

Loading

0 comments on commit 6ea82f8

Please sign in to comment.