validator outputs

[CPernet]

possible outputs features

• txt file out with validation status (useful to submit data papers)
• % of RECOMMENDED keys passed (0% = minimally compliant -- useful for people to check/choose data)
• % of OPTIONAL keys passed (useful for people to check/choose data)

discussed with @bendhouseart (who at some point did something comparing flags -- also refers to @effigies email about what is recommended)

[effigies]

• Text file: What is the contents of the text file, and where should it be placed?

• % RECOMMENDED: This would be a significant undertaking. We would need $\frac{present}{present + absent}$, and all we can readily get right now is $absent$. Counting $present$ or $present + absent$ will be difficult, as what is recommended for each file can depend on many conditions. Fields that are recommended in one table can be promoted to REQUIRED in other fields, so those would need to be subtracted.

• % OPTIONAL: This would require all of the work of the "% RECOMMENDED" task, plus starting to track the presence of OPTIONAL fields at all.

[CPernet]

• the text file can be optional, if requested, just returns what it there already --> BIDS valid, version x, N warnings left, date. As explained it useful for people like me who edit data paper, authors are always like yeah it's BIDS and when you check it isn't. We can ask to upload the txt file along the manuscript.

• for the other bits, I get your point, the relative mandatory/recommended dependency on other fields makes it super hard.