getDataCM: Get ClimMob data

Description Usage Arguments Value See Also Examples

View source: R/getDataCM.R

Description

Fetch the trial data from a ClimMob project using an application programming interface (API) key

Usage

1
getDataCM(key = NULL, project = NULL, tidynames = TRUE, pivot.wider = FALSE)

Arguments

key

a character for the user's application programming interface (API) key

project

a character for the project id

tidynames

logical, if TRUE suppress ODK strings

pivot.wider

logical, if TRUE return a wider object, each observer is a row

Value

A data frame with the project data

id

the participant's package id

moment

the data collection moment

variable

the variable name

value

the value for each variable

See Also

getProjectsCM

Examples

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

# This function will not work without an API key  
# the user API key can be obtained once a free ClimMob account 
# is created via https://climmob.net/climmob3/

my_key <- "add_your_key"
my_project <- "my_climmob_project"

data <- getDataCM(key = my_key, project = my_project)


## End(Not run)

kauedesousa/ClimMobTools documentation built on Feb. 14, 2020, 8:23 a.m.