Skip to content

growthcharts/james

Repository files navigation

R-CMD-check

Overview

JAMES is a web service for creating and interpreting charts of child growth and development. The current version

  1. provides access to high-quality growth charts used by the Dutch youth health care;
  2. interchanges data coded according to the Basisdataset JGZ 4.0.1;
  3. screens for abnormal height, weight and head circumference;
  4. converts developmental data into the D-score;
  5. predicts future growth and development.

JAMES is a RESTful API that runs on a remote host. The following sections illustrate how a client can make requests to JAMES using various client languages. In principle, any HTTP client will work with JAMES. The document highlights some applications of the service and provides pointers to relevant background information.

The service aids in monitoring and evaluating childhood growth. JAMES is created and maintained by the Netherlands Organisation for Applied Scientific Research TNO. Please contact Stef van Buuren <stef.vanbuuren at tno.nl> for further information.

Primary JAMES user functionality

Verb API Endpoint stem Description Maps to james function
POST /data/upload/{dfm} Upload child data upload_data()
POST /charts/draw/{ffm} Draw child data on growth chart draw_chart()
POST /charts/list/{dfm} List available growth charts list_charts()
POST /charts/validate/{dfm} Validate a chart code validate_chartcode()
POST /screeners/apply/{dfm} Apply growth screeners to child data apply_screeners()
POST /screeners/list/{dfm} List available growth screeners list_screeners()
POST /site/request/{dfm} Request personalised site request_site()
POST /blend/request/{sfm} Obtain a blend from multiple end points request_blend()
POST /version/{dfm} Obtain version information version()
GET /{session}/{info} Extract session details
GET /{2}/{1}/man Consult R help help({1}_{2})

The table lists the defined API end points and the mapping to each end point to the corresponding R function.

The current OpenAPI definition of JAMES is at https://app.swaggerhub.com/apis/stefvanbuuren/james/1.5.4. Note that this definition may evolve over time.

Resources

Internal

Description Status
Example requests current
OpenAPI specification current
Source files current
JSON data schema 3.0 current
JAMES issue tracker current

External

Description Status
JAMES demo current
Basisdataset JGZ current
OpenCPU API current