User Tools

Site Tools


codes:checklist

This is an old revision of the document!


CHECKLIST

Definition of the checklist functions that are developed in Eubrewnet

The users with the right permissions have access to some functions to directly check some tests that can be do to Brewers. The root of the access functions is the same for all http://rbcce.aemet.es/eubrewnet/data/checklist. From this point users can select different function. As Example Check SI.

The SI check function tests if the Brewer Operators perform Sittings periodically. The Regional Brewer Calibration Center Europe has stablished a standard of one test every week. The check is OK (returns True as result) if the number of Sittings per week is greater or equal to one. It is possible to modify the reference to change the number of sittings per week.

Description of the SI Check Function:

  • Function: SI
  • Description: The Sitting tests have to be done periodically. The RBCCE has stablished a standard of one test every week. The test is passed if the number of sittings per week during period is greater or equal to v2 (1 by default). v2 can be passed as parameter to change the reference value. For less than a sitting per week, use decimal values: for example, 0.25 means 1 sitting every month.
  • Inputs:
    1. v2: see V2. New reference to compare if there are enough Sittings during period
  • Output: Number of sittings during daterange and dates
    1. result: True if the number of Sittings is greater or equal
    2. v1: Number of Sittings during period
    3. v2: Reference value (1.0 by default)
    4. comments: List of dates when the sittings have been done

There is a Check Function Table with a summary of the available functions to perform tests and their links as example. The extended documentation for each function can be directly access from the table using the links in the column Long Description. There is a Google Spread Sheet with the complete table with all the information in one view.

There are common inputs for the functions as the parameter brewerid wich can be used in almost every function are listed in the common inputs section. A short description of the outpus can be found in the common outputs section.

For security purposes user authentication has been added to this tools and their use is registered.


COMMON

Common Inputs

Almost all functions receive the following inputs, too:

  • brewerid: Brewer identification number
  • date: Start date of a period (yyyy-mm-dd format)
  • enddate: End date of a period (yyyy-mm-dd format). If it is not provided, the period will be only one day.
  • v2 (optional): There are functions with reference values that can change depending on Brewer. Commonly

Common Outputs

All functions return the following outputs:

  • result: First returned value. True/False value if test is passed or not. Depending on the test, it will represent that the checked values are between limits of an interval, if all files are received, if process could be done…
  • v1: Second returned value. Commonly a set of measurements that have been gotten during process. Depending on the test it will be a list of measurements by date and time, an average value, detected values which rise a condition (for example, outliers)…
  • v2: Third returned value. Commonly it’s a complement value of V1 or a reference that can be passed to the function. Depending on the test it will be a list of values (for example, v1 contains passed values and v2 contains failed values), a reference value (Sitting function admits a v2 value to change the limit of one test / week), a calculation (v1 and v2 are the slope and v2 is the intercept of a linear regression)…
  • comments: Fourth returned value. In occasions, there is needed other value to finally understand a test. Depending on the test it will be a comment itself (For example, “Missing B/UV Files detected”), a percentage value (Comparison between passed measurements and total measurements), a list of complementary information (Dates where tests fail), a complementary value (Correlation coefficient in a linear regression)…

CHECK FUNCTIONS

codes/checklist.1480594262.txt.gz · Last modified: 2016/12/01 12:11 by bhcruz