find_studies: Extract available studies from the SQP 3.0 API

Description Usage Arguments Details Value Examples

View source: R/studies.R

Description

find_studies allows you to search for studies by names while get_studies will return all available studies in the SQP 3.0 database.

Usage

1
2
3

Arguments

study

a string with the name of the study. Upper and lower cases are ignored and regular expressions are supported.

Details

The user should almost always start by using find_studies which searches for a study based on it's name. If nothing useful comes up then use get_studies which will return all available studies.

The returned tibble will contain the id and name of the study/studies. The user should take note of the id of the desired study to checkout which questions are available using get_questions and find_questions.

Value

A two column tibble with the id and name of the study.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 

# Set your login information here. See ?sqp_login
sqp_login()

find_studies("ess")
find_studies("australia")

# or get_studies() for all studies

get_studies()


## End(Not run)

asqm/sqpr documentation built on May 28, 2020, 5:13 a.m.