ingest: Ingest smartsurvey data

Description Usage Arguments Value

View source: R/data.R

Description

Download smartsurvey export via the API. Download the exported data from smartsurvey using the API. Use convert_raw() to convert the API response to a data.frame.

Usage

1
2
3
4
5
6
7
ingest(
  survey = "790800",
  export = "1438876",
  token = Sys.getenv("CARS_TOKEN"),
  secret = Sys.getenv("CARS_SECRET"),
  check_hash = "6c64deda0580f9cf9cc6a32a3445472b13179053"
)

Arguments

survey

the survey ID (character string/numeric). Defaults to "790800".

export

the export ID (character string/numeric). Defaults to "1438876".

token

the API token (character string). Loaded from environment variable by default.

secret

the secret API token (character string). Loaded from environment variable by default.

check_hash

a hash to check the downloaded data aginst or FALSE to skip the check (character string/logical). Defaults to final export hash.

Value

the exported data as a dataframe


best-practice-and-impact/CARS2 documentation built on Dec. 19, 2021, 8:47 a.m.