getProjectsCM {ClimMobTools}R Documentation

Get ClimMob projects

Description

Fetch the status of ClimMob projects

Usage

getProjectsCM(key, server = "climmob3", ...)

Arguments

key

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

server

optional, a character to select from which server the data will be retrieved. See details

...

additional arguments passed to methods. See details

Details

server: the default server is "climmob" used for clients of https://climmob.net/climmob3/, other options are:

"avisa" for clients of https://avisa.climmob.net/

"rtb" for clients of https://rtb.climmob.net/

"testing" for clients of https://testing.climmob.net/climmob3/

Value

A data frame with the ClimMob projects

project_id

the project unique id

name

the project name

country

ISO code for the country where the project was implemented

status

the current status

creation_date

the project's creation date

intended_participants

the number of participants the project intended to register

intended_participants

the number of participants the project intended to register

registered_participants

the number of participants registered

last_registration_activity

number of days since the submission of the last registration

Author(s)

KauĂȘ de Sousa

See Also

ClimMob website https://climmob.net/

Other GET functions: getDataCM(), getProjectProgress()

Examples

## 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/

my_key <- "add_your_key"

getProjectsCM(key = my_key)


## End(Not run)


[Package ClimMobTools version 0.3.9 Index]