{
    "title": "Accrual",
    "chart": "accrual",
    "description": "JSON schema for the configuration of accrual chart",
    "overview": "The most straightforward way to customize the accrual chart is by using a configuration object whose properties describe the behavior and appearance of the chart. Since the accrual chart is a Webcharts `chart` object, many default Webcharts settings are set in the [webchartsSettings.js file](https://github.com/RhoInc/dashboard-charts/blob/master/src/accrual/configuration/webchartsSettings.js) as [described below](#webcharts-settings). Refer to the [Webcharts documentation](https://github.com/RhoInc/Webcharts/wiki/Chart-Configuration) for more details on these settings.\nIn addition to the standard Webcharts settings several custom settings not available in the base Webcharts library have been added to the accrual chart to facilitate data mapping and other custom functionality. These custom settings are described in detail below. All defaults can be overwritten by users.",
    "version": "0.1.0",
    "type": "object",
    "data-guidelines": "The Accrual chart accepts [JSON](https://en.wikipedia.org/wiki/JSON) data of the format returned by [`d3.csv()`](https://github.com/d3/d3-3.x-api-reference/blob/master/CSV.md). It plots the number of participants in each study populations by category.",
    "data-structure": "one record per participant per population with a discrete variable that plots on the y-axis\n\nNotes:\n- variables prefixed _filter:_ will appear as data filter controls as well as columns in the data listing\n- variables prefixed _listing:_ will appear as columns in the data listing",
    "data-file": "dashboard-accrual",
    "properties": {
        "category_col": {
            "title": "Category",
            "description": "variable: category",
            "type": "string",
            "default": "category",
            "data-mapping": true,
            "data-type": "character",
            "required": true
        },
        "category_abbreviation_col": {
            "title": "Category Abbreviation",
            "description": "variable: category abbreviation",
            "type": "string",
            "default": "category_abbreviation",
            "data-mapping": true,
            "data-type": "character",
            "required": false
        },
        "category_info_col": {
            "title": "Category Info",
            "description": "variable: category info",
            "type": "string",
            "default": "category_info",
            "data-mapping": true,
            "data-type": "character",
            "required": false
        },
        "id_col": {
            "title": "Participant ID",
            "description": "variable: participant ID",
            "type": "string",
            "default": "subjid",
            "data-mapping": true,
            "data-type": "character",
            "required": false
        },
        "population_col": {
            "title": "Population",
            "description": "variable: population",
            "type": "string",
            "default": "population",
            "data-mapping": true,
            "data-type": "character",
            "required": true
        },
        "population_order_col": {
            "title": "Population Order",
            "description": "variable: population order",
            "type": "string",
            "default": "population_order",
            "data-mapping": true,
            "data-type": "numeric",
            "required": false
        },
        "population_color_col": {
            "title": "Population Color",
            "description": "variable: population color",
            "type": "string",
            "default": "population_color",
            "data-mapping": true,
            "data-type": "numeric",
            "required": false
        },
        "population_superset_col": {
            "title": "Subset of:",
            "description": "variable: population superset, e.g. the superset of the randomized population is the screened population",
            "type": "string",
            "default": "population_superset",
            "data-mapping": true,
            "data-type": "character",
            "required": false
        },
        "date_col": {
            "title": "Date",
            "description": "date variable name in YYYY-MM-DD format",
            "type": "string",
            "default": "date",
            "data-mapping": true,
            "data-type": "character",
            "required": false
        }
    }
}