Commit 8fe199dc authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

DOC: small tweaks

parent d070047a
......@@ -139,10 +139,7 @@ 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
``<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):
the following files[*]_:
* ``funpack/configs/fmrib/datacodings_*.tsv``: Cleaning rules for data
codings
......@@ -151,6 +148,11 @@ the following files (the ``funpack/`` directory is located in
* ``funpack/configs/fmrib/processing.tsv``: Processing steps
* ``funpack/configs/fmrib/categories.tsv``: Variable categories
.. [*] 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.
You can use these rules by using the FMRIB configuration profile::
......@@ -294,7 +296,7 @@ Tests
To run the test suite, you need to install some additional dependencies::
pip install fmrib-unpack[test]
pip install fmrib-unpack[test]
Then you can run the test suite using ``pytest``::
......
......@@ -145,7 +145,8 @@ def importData(fileinfo,
the processing rules are selected for import if
present in the input file(s) and not already
selected, and . See the ``take`` argument to
:func:`.binariseCategorical` for an example.
:func:`.processing_functions.binariseCategorical`
for an example.
:arg njobs: Number of processes to use for parallelising tasks.
......
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