Browse Source

Incorporate changes in structure in the code and README.

Jan Yperman 3 years ago
parent
commit
88cfdafbd4
2 changed files with 6 additions and 6 deletions
  1. 5 5
      README.md
  2. 1 1
      code/sample_use_case.ipynb

+ 5 - 5
README.md

@@ -14,10 +14,10 @@ machine learning techniques for time series analysis and predictive modelling.
 # Usage
 
 ## Downloading the dataset
-There are a few ways to download the dataset ([mep_dataset.zip](mep_dataset.zip)). Since it is a fairly small filesize (~300MB), it can just be downloaded through the web interface.
+There are a few ways to download the dataset ([data/mep_dataset.zip](data/mep_dataset.zip)). Since it is a fairly small filesize (~300MB), it can just be downloaded through the web interface.
 Or from the commandline:
 ```bash
-wget https://gin.g-node.org/JanYperman/motor_evoked_potentials/raw/master/mep_dataset.zip
+wget https://gin.g-node.org/JanYperman/motor_evoked_potentials/raw/master/data/mep_dataset.zip
 ```
 
 Alternatively, you may clone the repository to your local machine, which will also include the dataset:
@@ -29,7 +29,7 @@ git clone https://gin.g-node.org/JanYperman/motor_evoked_potentials.git
 For more ways of accessing the data, please refer to GIN's [FAQ](https://gin.g-node.org/G-Node/Info/wiki/FAQ+Troubleshooting#how-can-i-access-the-data).
 
 ## Structure
-The dataset itself is stored in [mep_dataset.zip](mep_dataset.zip). The general structures is as follows:
+The dataset itself is stored in [data/mep_dataset.zip](data/mep_dataset.zip). The general structures is as follows:
 
 * __patient.csv:__ Contains the records for the various patients.
 * __visit.csv:__ Contains the records for the various visits.
@@ -37,12 +37,12 @@ The dataset itself is stored in [mep_dataset.zip](mep_dataset.zip). The general
 * __measurement.csv:__ Contains the records for the various measurements.
 * __edss.csv:__ Contains the records for the various edss measurements.
 
-Besides these files the dataset also contains textfiles for each of the actual time series. The filenames of these files contain a unique identifier which can be used to link back to the column "timeseries" in the measurement.csv file. Some code to automate this linking (in Python) is included in [create_df_from_portable_dataset.py](create_df_from_portable_dataset.py).
+Besides these files the dataset also contains textfiles for each of the actual time series. The filenames of these files contain a unique identifier which can be used to link back to the column "timeseries" in the measurement.csv file. Some code to automate this linking (in Python) is included in [code/create_df_from_portable_dataset.py](code/create_df_from_portable_dataset.py).
 
 More details about specifics fields can be found in the dataset descriptor.
 
 ## Getting started
-It is highly recommended to have a look at the included [jupyter notebook](sample_use_case.ipynb) to familiarize oneself with the dataset.
+It is highly recommended to have a look at the included [code/jupyter notebook](code/sample_use_case.ipynb) to familiarize oneself with the dataset.
 It includes a sample use case and goes over how to work with the dataset.
 
 To run the jupyter notebook a few Python packages are required:

+ 1 - 1
code/sample_use_case.ipynb

@@ -82,7 +82,7 @@
     "    df = pd.read_pickle(cached_mep_path)\n",
     "    cdf = pd.read_pickle(cached_edss_path)\n",
     "else:\n",
-    "    df, cdf = create_df_from_portable_dataset.single_dataframe('mep_dataset.zip')\n",
+    "    df, cdf = create_df_from_portable_dataset.single_dataframe('../data/mep_dataset.zip')\n",
     "    df.to_pickle(cached_mep_path)\n",
     "    cdf.to_pickle(cached_edss_path)"
    ]