Skip to content

Commit

Permalink
fix linting
Browse files Browse the repository at this point in the history
  • Loading branch information
karacolada committed May 3, 2024
1 parent 4c6c528 commit 0aadc41
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions metrics_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Copy the YAML content of this metric file to a new metric file and save the file

To define own metrics you can restrict the number of metrics and add configuration options to a limited number of existing metrics.

### Configure metrics and tests to be performed
### Configure metrics and tests to be performed

To restrict metrics choose those you want to use from the 0.6 list of metrics and tests and simply delete tests or metrics which you do not wish to be performed during your assessments.

Expand All @@ -26,12 +26,12 @@ For all metrics and tests you can change the YAML properties*metric_short_name*,

For some tests you can define additional parameters. For example, one can specify exactly which metadata elements, licenses, metadata standards or vocabularies are expected.

Generally, these specifications are defined using the YAML property *community_requirements* which has to be a dictionary containing the subproperties *target*, *modality*, and *required*.
Generally, these specifications are defined using the YAML property *community_requirements* which has to be a dictionary containing the subproperties *target*, *modality*, and *required*.

* *target* defines the test targets, defined in the F-UJI ontology, such as licenses, metadata properties etc. which is represented by a controlled list of values which is used for tests by default.
* *required* has to be a list which defines the necessary property values
* *modality* defines if *all* or *any* of *required* values need to be present to pass the test.
*match* specifies how matching values are identified: *wildcard* for wildcard-like match rules like 'test*'; *full* when a full match is required.
* *modality* defines if *all* or *any* of *required* values need to be present to pass the test.
*match* specifies how matching values are identified: *wildcard* for wildcard-like match rules like 'test*'; *full* when a full match is required.
*target_property* additionally defines the property of the *target* object in which matches are searched for, by default the property *name* or *label* is used for this purpose.
*modality* and *match* are currently not yet implemented, thus still hardcoded :( but may be implemented in future versions.

Expand Down

0 comments on commit 0aadc41

Please sign in to comment.