v6-euracan-algorithms

Disclosure Settings

VTG_PREPROCESS_MIN_RECORDS_THRESHOLD

Building Image

Development build

make docker PKG_NAME=vtg.chisq

Release build (should only be triggered by CI, see release section below)

make docker PKG_NAME=vtg.chisq TAG=x.x.x

You can also use the specialized make rules for building the image, for example:

make chisq

to build a development image for the vtg.chisq package. Or you can build a release image with (should only be triggered by CI, see release section below):

make chisq TAG=x.x.x

Release

To make a release you need to tag the commit with the algorithm and version number, for example:

git tag -a [ALGORITHM]/1.0.0 -m "Release 1.0.0"
git push origin [ALGORITHM]/1.0.0

With [ALGORITHM] being the name of the algorithm:

• chisq
• summary
• survfit
• survdiff
• coxph
• crosstab

Documentation

The documentation is generated using sphinx. To generate the documentation you need to install the dependencies:

pip install -r docs/requirements.txt

Then you can generate the documentation with:

cd docs
make livehtml

Then you can view the documentation at http://localhost:8000.