Skip to content

Commit

Permalink
fixes #84
Browse files Browse the repository at this point in the history
  • Loading branch information
JohannesWiesner committed May 7, 2024
1 parent c78beba commit 94fc39a
Show file tree
Hide file tree
Showing 3 changed files with 236 additions and 169 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,14 @@ The input spreadsheet file needs to have the following columns:

This repository includes a testing pipeline that checks for the integrity of / valid entries in the `packages.tsv`. Which tests are running is decided using the `test_configs.json` file. Each tests corresponds to a key within the `json` file. If the corresponding value is `null` the test is not being executed. Here's an explanation of each test and rules for how the values should be provided in case the test should be executed.

| key | value | description |
|---------------------|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| valid_columns | list of column names | tsv file must only have these columns in that specific order |
| filled_out_columns | list of column names | cells in these columns must not contain NaNs, i.e. every row within these columns must contain a value |
| valid_options | dict with column names as keys and list of valid options as values | cells in these columns must only contain these values |
| column_dependencies | dict with column names as keys and list of other columns as values | if a cell in this column is filled out, cells in this/these other column(s) also have to be filled out |
| multi_option_columns| dict with column names as keys and list of valid options as values | cells in these columns must only contain valid options separated by commas |
| key | value | description |
|--------------------------------|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| valid_columns | list of column names | tsv file must only have these columns in that specific order |
| filled_out_columns | list of column names | cells in these columns must not contain NaNs, i.e. every row within these columns must contain a value |
| valid_options | dict with column names as keys and list of valid options as values | cells in these columns must only contain these values |
| column_dependencies | dict with column names as keys and list of other columns as values | if a cell in this column is filled out, cells in this/these other column(s) also to be filled out |
| conditional_column_dependencies| dict of dict of lists | if a cell in this column has this value, cells in this/these other column(s) have to be filled out |
| multi_option_columns | dict with column names as keys and list of valid options as values | cells in these columns must only contain valid options separated by commas |

### CRAN-packages
**EDIT: Still in development!**
Expand Down
3 changes: 2 additions & 1 deletion tcy/test_configs.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"valid_columns": ["package_name","version","package_manager","conda_channel","necessity","language","bug_flag"],
"filled_out_columns": ["package_name","package_manager","necessity","language"],
"valid_options": {"package_manager":["conda","pip","cran"],"language":["python","r","julia"],"bug_flag":["linux","windows","cross-platform"],"necessity":["required","optional"]},
"valid_options": {"package_manager":["conda","pip","cran"],"language":["python","r","julia"],"bug_flag":["linux","windows","cross-platform","nan"],"necessity":["required","optional"]},
"column_dependencies": null,
"conditional_column_dependencies": null,
"multi_option_columns": null
}
Loading

0 comments on commit 94fc39a

Please sign in to comment.