Documention

We really should do some docu.

Very Important:

• update README.md

For Developer:

• general architectural overview
• description of the evaluation machinery
• how to use the flagger (purpose, how, limitations)
• how to add new flagger (location, interface)
• how to add test functions (location, interface)

For User:

• Quick start tutorial
• Description of the test specification syntax
• Description of the available tests and routines:
  • routine signatures, (need a new sync with actual names)
  • routine descriptions, (need a new sync with actual names)
• Separate description of the concepts of:
  • (De-) Harmonization
  • Execution via cmd-line/in-script
  • Implementation of own functions
  • Using a custom flagging scheme
  • Training and use of ML-models
  • Express Badie-Policy somewhere (currently available in the wiki, should move into the repo though)
• Currently undocumented or falsely documented features/routines
  • spikes_flagMultivarScores
  • dataprocessing module (resampling, transforming, interpolating)
  • flagCrossScores
  • slidingZscore

added 1 deleted label

removed 1 deleted label

changed title from Document Functionality and Features to Documention

changed the description

marked the checklist item routine signatures as completed

I added two documents to docs. Could you please take care of docs/FunctionDescriptions @luenensc ?

changed the description

changed the description

changed the description

I would like to change 2 things in the doc structure:

1. Somehow our doc file looks quit unstructured when scrolling through. I know the possibilities of markdown are limited, but i think by simply moving the function description underneath the function headline (its name) and afterwards listing the parameters will make the thing more user welcoming.

2. By now, we are listing flagging and harmonization functions under one headline (function descriptions) - but since flagging functions just alter the flagger, but harmonization functions alter flagger AND data AND data/_flags shape, there are, i think two classes of functionalities, comment-less mixed in one doc file. Since there will be wrapper added for harmonization, interpolation and aggregation next week, i think, those functions that are more considered with data processing than with data flagging should somehow be extra-signified, maybe by summarizing them in an own doc file.

to 1.:

i think: just remove all occurrence of ### Signature, ### Parameters and ### Description and remove the backticks of the headings would improve readability a lot. Especially as the markdown itself, should be readable nicely, even if it is not rendered.

like so:

range

range(min, max)

parameter	data type	default value	description
min	float		Upper bound for valid values. ( $<$ )
max	float		lower bound for valid values. ( $\geq$ )

The function flags all the values, that exceed the right open interval

$[$

min, max

$)$

.

marked the checklist item routine signatures as incomplete