Commit d070047a authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

DOC: changelog, readme

parent c4a6abad
......@@ -14,6 +14,8 @@ Added
specified in the processing rules to be selected for import, if present
in the data, and not already selected. This option is enabled in the
``fmrib`` configuration profile.
* The ``$FUNPACK_CONFIG_DIR`` environment variable can be used to direct
FUNPACK to a directory containing configuration, table, and plugin files.
Changed
......
......@@ -139,10 +139,13 @@ Built-in rules
FUNPACK contains a large number of built-in rules which have been specifically
written to pre-process UK BioBank data variables. These rules are stored in
the following files (the `funpack/` directory is located in your Python
environment directory):
the following files (the ``funpack/`` directory is located in
``<python-env>/lib/python<X.Y>/site-packages/funpack/``, where
``<python-env>`` is the location of your Python environment directory, and
``<X.Y>`` is the Python version you are using):
* ``funpack/configs/fmrib/datacodings_*.tsv``: Cleaning rules for data codings
* ``funpack/configs/fmrib/datacodings_*.tsv``: Cleaning rules for data
codings
* ``funpack/configs/fmrib/variables_*.tsv``: Cleaning rules for individual
variables
* ``funpack/configs/fmrib/processing.tsv``: Processing steps
......@@ -166,7 +169,12 @@ contains the cleaning rules for each variable.
separately from FUNPACK at
https://git.fmrib.ox.ac.uk/fsl/funpack-fmrib-config/. However, it is
automatically installed alongside FUNPACK, so if you have FUNPACK,
you can use the ``fmrib`` profile.
you can use the ``fmrib`` profile. If you are using FUNPACK from a
source checkout, you may need to install the
``fmrib-unpack-fmrib-config`` package from `PyPi
<https://pypi.org/project/fmrib-unpack-fmrib-config/>`_ or
`conda-forge
<https://anaconda.org/conda-forge/fmrib-unpack-fmrib-config>`_.
Creating your own rule files
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment