Add example config file in the help documentation

[lizhiweiyy]

Is your feature request related to a problem? Please describe.
All the examples in the documentation have used a config file with the following code:

import conf #This is the local config file named conf.py
odir = conf.SUPPLEMENTS_DIR
kinase_dict[kinase] = conf.KINASE_MAP.loc[kinase,'Preferred Name']

This indicates we need to create a custom file ‘conf.py’ in the working directory, but there isn't any example file.
There are two attributes in the file:
SUPPLEMENTS_DIR, which is a string variable indicating a file path,
and KINASE_MAP, which is a kinase dictionary object, however, it's not clear how to define the variable ‘KINASE_MAP’ in the config file.

Describe the solution you'd like
Add an example file conf.py for download in the help documentation

[srcrowl]

Thanks for bringing this to our attention, sorry for the missing information. The conf.py file is very simple, and is really just used to indicate the directory containing the supplementary data, and then load in the kinase map file. At a minimum, all the conf.py file needs to contain is the following:

import pandas as pd

#where supplementary data was downloaded to
SUPPLEMENTS_DIR = './'

#load kinase map from supplementary data
KINASE_MAP =  pd.read_csv(SUPPLEMENTS_DIR+'SupplementaryData/Map/globalKinaseMap.csv', index_col = 0)`

Alternatively, you could avoid using an external file and just include this code in the same python script.

We will update the documentation accordingly, and will close this issue once the issue is clarified.