getProjectsCM {ClimMobTools}

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:

"1000farms" for clients of https://1000farms.climmob.net/

Value

A data.frame with the variables:

project_id

the project's id

project_name

the project's name

user_owner

the account name that owns the project

country

the country of project's implementation

status

the current status

creation_date

date where the project was created

Author(s)

Kauê de Sousa

See Also

ClimMob website https://climmob.net/

Other GET functions: getDataCM(), getProjectProgress()

Examples

# This function only works with an API key
# the API key can be obtained once a free ClimMob account
# is created via https://climmob.net/

my_key <- "ff05a174-28d0-4a40-ab5a-35dc486133a6"

getProjectsCM(key = my_key, server = "1000FARMS")