getProjectsCM: Get ClimMob projects

Description Usage Arguments Value See Also Examples

View source: R/getProjectsCM.R

Description

Get ClimMob projects using an application programming interface (API) key

Usage

1

Arguments

key

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

Value

A data frame with the ClimMob projects

project_id

the project unique id

name

the project name

status

the current status

creation_date

the project's creation date

intended_participants

the number of participants the project intended to register

registration_progress

the percentage of intended participants which were registered

last_registration_activity

number of days since the submission of the last registration

See Also

https://climmob.net/climmob3/

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## 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"

getProjectsCM(key = my_key)


## End(Not run)

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