Skip to content

Version 2.0.0 - Kagoshima

Compare
Choose a tag to compare
@nvnieuwk nvnieuwk released this 22 Apr 11:19
· 223 commits to master since this release
1c34f5e

To migrate from nf-validation please follow the migration guide

New features

  • Added the uniqueEntries keyword. This keyword takes a list of strings corresponding to names of fields that need to be a unique combination. e.g. uniqueEntries: ['sample', 'replicate'] will make sure that the combination of the sample and replicate fields is unique. (#141)
  • Added samplesheetToList which is the function equivalent of .fromSamplesheet #3
  • Added a warning if the nf-schema version is unpinned. Let's hope this prevents future disasters like the release of nf-validation v2.0 😁

Changes

  • Changed the used draft for the schema from draft-07 to draft-2020-12. See the 2019-09 and 2020-12 release notes for all changes (#141)
  • Removed the fromSamplesheet channel operator and added a samplesheetToList function instead. This function validates the samplesheet and returns a list of it. #3
  • Removed the unique keyword from the samplesheet schema. You should now use uniqueItems or uniqueEntries instead (#141)
  • Removed the skip_duplicate_check option from the samplesheetToList() function and the --validationSkipDuplicateCheck parameter. You should now use the uniqueEntries or uniqueItems keywords in the schema instead (#141)
  • samplesheetToList() now does dynamic typecasting instead of using the type fields in the JSON schema. This is done due to the complexity of draft-2020-12 JSON schemas. This should not have that much impact but keep in mind that some types can be different between this version and older versions in nf-validation (#141)
  • samplesheetToList() will now set all missing values as [] instead of the type specific defaults (because of the changes in the previous point). This should not change that much as this will also result in false when used in conditions. (#141)
  • Removed the configuration parameters and added configuration options instead. For a full list of these new options, please have a look at the configuration docs

Improvements

  • Setting the exists keyword to false will now check if the path does not exist (#141)
  • The schema keyword will now work in all schemas. (#141)
  • Improved the error messages (#141)
  • samplesheetToList now supports deeply nested samplesheets (#141)