From 74a31449540a97e92572ccc111ee0aba59717cdc Mon Sep 17 00:00:00 2001 From: Alan Liddell Date: Wed, 6 Feb 2019 12:32:57 -0500 Subject: [PATCH] update docs for importv3 --- docs/usage/index.rst | 2 ++ docs/usage/migrating.rst | 10 ++++++++++ 2 files changed, 12 insertions(+) diff --git a/docs/usage/index.rst b/docs/usage/index.rst index d4fb3391..f824d890 100644 --- a/docs/usage/index.rst +++ b/docs/usage/index.rst @@ -71,6 +71,8 @@ Documentation and help Pipeline commands ~~~~~~~~~~~~~~~~~ +- ``jrc importv3 mysession_jrc.mat``: Import a JRCv3 ``_jrc.mat`` file to the new format. + **Does not overwrite your old results.** - ``jrc bootstrap``: Create a :ref:`config file `. - ``jrc detect myparams.prm``: Perform spike detection and feature extraction. (Replace ``myparams`` with a unique name of your choosing.) diff --git a/docs/usage/migrating.rst b/docs/usage/migrating.rst index fdcf6964..5fa4aa19 100644 --- a/docs/usage/migrating.rst +++ b/docs/usage/migrating.rst @@ -14,3 +14,13 @@ What's different - Logging and curation history are stored in the DensityPeakClustering object ``hClust``, instead of in a separate file where they might get out of sync. - You must specify your parameter file for every invocation of JRCLUST. - JRCLUST will overwrite old config files and save a backup copy to 'filename.prm.bak'. + +.. note:: + + Old sortings must be manually imported with ``jrc importv3 mysession_jrc.mat``. + This will output ':ref:`mysession_res.mat `' and update your config file. + (A backup will be made of your config file at 'mysession.prm.bak'.) + Additionally, your '_spkraw.jrc', '_spkwav.jrc', and '_spkfet.jrc' will be renamed + to ':ref:`_raw.jrc `', ':ref:`_filt.jrc `', and + ':ref:`_features.jrc `', respectively. + Nothing will be altered except for this renaming.