docs(builtins): add aggregation-method to the docs

src/if-run/builtins/coefficient/README.md

@@ -18,17 +18,19 @@ Three parameters are required in global config: `input-parameter`, `coefficient`
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit`
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method`
 of the parameters of the inputs and outputs
 
 - `inputs`: describe parameters of the `input-parameter` of the global config. Each parameter has:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe parameters of the `output-parameter` of the global config. Each parameter has:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs
 

src/if-run/builtins/copy-param/README.md

@@ -41,16 +41,18 @@ Three parameters are required in config: `from` and `to` and `keep-existing`.
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe the parameter of the `from` of the global config. The parameter has the following attributes:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the parameters of the `to` of the global config. The parameter has the following attributes:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs
 

src/if-run/builtins/csv-lookup/README.md

@@ -53,6 +53,21 @@ All the following values are valid for the `output` field:
 - `["processor-name", "processor-model-id"]`
 - `[["processor-name", "processor-model-id"],["tdp","thermal-design-power"]]`
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameters of the `inputs`. Each parameter has:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the parameters in the `output` of the config block. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Inputs
 
 There are no strict requirements on input for this plugin because they depend upon the contents of the target CSV and your input data at the time the CSV lookup is invoked. Please make sure you are requesting data from columns that exist in the target csv file and that your query values are available in your `input` data.

src/if-run/builtins/divide/README.md

@@ -14,16 +14,18 @@ You provide the names of the values you want to divide, and a name to use to add
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe the parameter of the `numerator` of the global config. The parameter has the following attributes:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the parameter of the `denominator` of the global config. The parameter has the following attributes:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs
 

src/if-run/builtins/exponent/README.md

@@ -18,16 +18,18 @@ Three parameters are required in global config: `input-parameter`, `exponent` an
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe the parameter of the `input-parameter` of the global config. The parameter has the following attributes:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the parameter of the `output-parameter` of the global config. The parameter has the following attributes::
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs
 

src/if-run/builtins/interpolation/README.md

@@ -27,16 +27,18 @@ To employ the `Interpolation` plugin, adhere to these steps:
 
 ## Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe the parameter of the `input-parameter` of the global config. The parameter has the following attributes:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the parameters of the `output-parameter` of the global config. The parameter has the following attributes:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ## Input Parameters
 

src/if-run/builtins/mock-observations/README.md

@@ -17,6 +17,21 @@ The mode currently mocks 2 types of observation data:
 - `generators` define which fields to generate for each observation
 - `components` define the components for which to generate observations. The observations generated according to `timestamp-from`, `timestamp-to`, `duration` and `generators` will be duplicated for each component.
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameters of the `inputs`. Each parameter has:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the output parameters. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Authentication
 
 N/A

src/if-run/builtins/multiply/README.md

@@ -17,16 +17,18 @@ Two parameters are required in global config: `input-parameters` and `output-par
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe parameters of the `input-parameters` of the global config. Each parameter has:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the parameter of the `output-parameter` of the global config. The parameter has the following attributes:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs
 

src/if-run/builtins/regex/README.md

@@ -18,16 +18,18 @@ Intel® Xeon® Platinum 8272CL,Intel® Xeon® 8171M 2.1 GHz,Intel® Xeon® E5-26
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe the parameter of the `parameter` value of the global config. The parameter has the following attributes:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the parameters of the `output` of the global config. The parameter has the following attributes:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs
 
@@ -37,7 +39,6 @@ The `parameter-metadata` section contains information about `description` and `u
 
 - `output`: The match of the `parameter` value using the `match` regex defined in the global config. If the `match` regex includes the global flag (`g`), a string containing all matches separated by spaces.
 
-
 ## Implementation
 
 To run the plugin, you must first create an instance of `Regex`. Then, you can call `execute()`.

src/if-run/builtins/sci-embodied/README.md

@@ -12,16 +12,18 @@ Not Needed
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe the parameters of the `inputs`. Each parameter has:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the `carbon-embodied` parameter. The parameter has the following attributes:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs
 

src/if-run/builtins/sci/README.md

@@ -10,16 +10,18 @@
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe parameters of the `inputs`. Each parameter has:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the `sci` parameter which has the following attributes:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs
 

src/if-run/builtins/shell/README.md

@@ -22,6 +22,21 @@ The `shell` plugin interface requires a path to the plugin command. This path is
 
 - `command`: the path to the plugin executable along with the execution command as it would be entered into a shell.
 
+### Plugin parameter metadata
+
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
+
+- `inputs`: describe the parameters of the `inputs`. Each parameter has:
+
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
+- `outputs`: describe the output parameter. The parameter has the following attributes:
+  - `description`: description of the parameter
+  - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
+
 ### Inputs
 
 The parameters included in the `inputs` field in the `manifest` depend entirely on the plugin itself. A typical plugin might expect the following common data to be provided as `inputs`:

src/if-run/builtins/subtract/README.md

@@ -17,16 +17,18 @@ Two parameters are required in global config: `input-parameters` and `output-par
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe parameters of the `input-parameters` of the global config. Each parameter has the following attributes:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the parameter of the `output-parameter` of the global config. The parameter has the following attributes:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs
 

src/if-run/builtins/sum/README.md

@@ -17,16 +17,18 @@ Two parameters are required in global config: `input-parameters` and `output-par
 
 ### Plugin parameter metadata
 
-The `parameter-metadata` section contains information about `description` and `unit` of the parameters of the inputs and outputs
+The `parameter-metadata` section contains information about `description`, `unit` and `aggregation-method` of the parameters of the inputs and outputs
 
 - `inputs`: describe parameters of the `input-parameters` of the global config. Each parameter has:
 
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 - `outputs`: describe the parameter of the `output-parameter` of the global config. The parameter has the following attributes:
   - `description`: description of the parameter
   - `unit`: unit of the parameter
+  - `aggregation-method`: aggregation method of the parameter (it can be `sum`, `avg` or `none`)
 
 ### Inputs