diff --git a/README.md b/README.md index 61f25f01..5109e629 100644 --- a/README.md +++ b/README.md @@ -89,41 +89,6 @@ To prepare your data you will need to format your data into AnnData format using data.write("data.h5ad") ``` -5. Create config file (optional) - - If you do not have a config file, the schema (metadata names, types, and categorical/continuous) will be inferred from the observations in the data file. Config file is required to be named 'data_schema.json' and located in the same directory as data file. - - The config file is a JSON format file with information on the metadata associated with the cells. The key is the column name in obs. The value is an object - ``` - type: string, int, or float (what type the values are), - variabletype: categorical or continuous (categorical values are displayed as checkboxes, continuous values are displayed as a histogram) - displayname: (what the heading should be displayed as) - include: True/False (whether to display values on web interface) - ``` - - ``` - Example - { - "CellName": { - "type": "string", - "variabletype": "categorical", - "displayname": "Name", - "include": true - }, - "clusters": { - "type": "string", - "variabletype": "categorical", - "displayname": "Clusters", - "include": true - }, - "num_genes": { - "type": "int", - "variabletype": "continuous", - "displayname": "Number Genes", - "include": true - } - } - ``` - ## Contributing We warmly welcome contributions from the community. Please submit any bug reports and feature requests through github issues. Please submit any direct contributions via a branch + pull request.