API-Docs
#########

Field Design API
==================================
.. csv-table:: AgriOS Field Design API
    :file: /AgriOS/api-field-design.csv
    :header-rows: 1


Parameters of field design API
-------------------------------
.. csv-table:: Parameters Field Design
    :file: /AgriOS/api-field-design-parameters.csv
    :header-rows: 1


.. csv-table:: Structure of Input File for Field Design
    :file: /AgriOS/api-field-design-file.csv
    :header-rows: 1


Example input data of field design 
-----------------------------------
.. literalinclude:: /AgriOS/pl.json
  :language: JSON
  :lines: 1-31

Showcase of field design usage
--------------------------------

Field design of diagonal augmented trials
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: shell

    curl http://your.server.com/ocpu/library/AgriOS/R/design_exp \
    -d "data=home/root/Data/entries-diagonal.json&design='diagonal'&nrows=18&ncols=18&as.json=true"


Field design of randomized complete block design
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: shell
    
    curl http://your.server.com/ocpu/library/AgriOS/R/design_exp \
    -d "data=home/root/Data/entries-rcbd.json&design='rcbd'&blocks=3&nrows=7&ncols=10&as.json=true" 

Data Analysis API
====================
.. csv-table:: AgriOS Field Data Analysis API
    :file: /AgriOS/api-field-design-input.csv
    :header-rows: 1



Parameters of field design API
-------------------------------

.. csv-table:: Parameters Data Analysis
    :file: /AgriOS/api-data-analysis-parameters.csv
    :header-rows: 1

.. csv-table:: Structure of Input File for Data Analysis
    :file: /AgriOS/api-data-analysis-file.csv
    :header-rows: 1

Output of analysis of contrast design
--------------------------------------
.. csv-table:: Output of Contrast Design Analysis
    :file: /AgriOS/output-contrast.csv
    :header-rows: 1

Output of analysis of interval contrast design
-----------------------------------------------
.. csv-table:: Output of Interval Contrast Design Analysis
    :file: /AgriOS/output-interval.csv
    :header-rows: 1


.. Example input data of trial data analysis 
.. -------------------------------------------

.. .. literalinclude:: /AgriOS/besag.json
..   :language: JSON
..   :lines: 1-106

Showcase of data analysis usage
--------------------------------


.. code-block:: shell
    
    # Analysis of randomized design trials
    curl http://your.server.com/ocpu/library/AgriOS/R/fd_analysis \
    -d "file='home/root/Data/besag.json'&design='rcbd'&log.path='/your/log/path'&as.json=true" 

.. code-block:: shell

    curl http://180.184.76.202:8080/ocpu/library/AgriOS/R/fd_analysis \
    -d "file='/home/root/Data/data_contrast.json'&design='contrast'&as.json=true"

.. code-block:: shell

    curl http://180.184.76.202:8080/ocpu/library/AgriOS/R/fd_analysis \
    -d "file='/home/root/Data/data_contrast.json'&design='interval_contrast'&as.json=true"