Version 1.42.3

This version fixes an issue with exporting LINcode fields with isolate records.

Version 1.41.2

This version includes the following:

• Search isolates by SAVs or SNPs defined in typing database.
• Use caching for dashboard AJAX calls where possible.
• Add option to batch download full allele records via API - see https://bigsdb.readthedocs.io/en/latest/rest.html#db-loci-locus-alleles.
• Fix for export of LINcode field values.

Full Changelog: v_1.42.1...v_1.42.2

Version 1.42.1

This introduces the following changes:

• Update to FontAwesome 6.
• Provenance completeness metrics – these work like scheme annotation metrics, but you can define specific fields in config.xml as important for completeness (set annotation_metric=”yes” in the field definition). Note the new update_provenance_metrics.pl script if you want to cache the metrics table (although it calculates on-the-fly and is pretty quick if not used). The score is simply a percentage of selected fields with a value (null values are excluded – see https://github.com/kjolley/BIGSdb/blob/develop/lib/BIGSdb/Constants.pm#LL296C1-L298C4 for definitions of these).
• Isolates can now be searched by allele extended attributes defined in the typing database (https://bigsdb.readthedocs.io/en/latest/administration.html#defining-locus-extended-attributes).

Version 1.42.0

This version adds the option to define schemes that can include locus presence in profile definitions. This can be enabled by setting the 'allow_presence' flag in a scheme definition and then using the value 'P' for 'present' within a profile. Locus absence can be assigned with a '0'. Note that scheme caching must be enabled in isolate databases to make use of these gene presence schemes.

There is also a new single amino acid variant (SAAV) and single nucleotide polymorphism (SNP) detection tool. SAAVs and SNPs can be defined for a locus, and then alleles can be annotated by running the new scan_mutations.pl script. SAAV and SNPs will be displayed within allele records, and can be searched in locus-specific queries in the typing database.

Finally, security of cookies has been improved with -secure and -httponly attributes set. Note that to prevent breaking installations running over HTTP, to enable -secure you need to set secure_cookies=1 in bigsdb.conf.

Version 1.41.3

Version 1.41.3 adds a plugin to run Kleborate (https://github.com/katholt/Kleborate) to screen genome assemblies of Klebsiella pneumoniae and the Klebsiella pneumoniae species complex (KpSC) for:

• MLST sequence type
• species (e.g. K. pneumoniae, K. quasipneumoniae, K. variicola, etc.)
• ICEKp associated virulence loci: yersiniabactin (ybt), colibactin (clb), salmochelin (iro), hypermucoidy (rmpA)
• virulence plasmid associated loci: salmochelin (iro), aerobactin (iuc), hypermucoidy (rmpA, rmpA2)
• antimicrobial resistance determinants: acquired genes, SNPs, gene truncations and intrinsic β-lactamases
• K (capsule) and O antigen (LPS) serotype prediction, via wzi alleles and Kaptive

The output is a table in HTML, tab-delimited text, and Excel formats.

In addition, if the analysis is run with the --all option then the results are stored as an arbitrary analysis within the isolate database linked to the isolate record (this is the same way that we store the rMLST species identification in the screenshot below). A formatted display of these results is available in the isolate information page.

The analysis can also be run using a standalone script - update_kleborate.pl - found in the scripts/maintenance directory. This will run the analysis against all isolates in a database and populate the arbitrary analysis table for display.

Arbitrary analysis results are stored within the isolate database as a JSON object and can be displayed within isolate information pages using a template file stored in /etc/bigsdb/templates. Currently, this information is not searchable within the BIGSdb search interface, but the plan is to develop this so that specific fields can be registered for searching.

Kleborate needs to be installed on the system and the path to the executable file specifed in the BIGSdb global configuration file (/etc/bigsdb/bigsdb.conf), e.g.

kleborate_path=/usr/local/bin/kleborate

The plugin is not enabled by default, even on databases with all_plugins="yes" set in the config.xml file, as it is only appropriate for use against Klebsiella assemblies. To enable the plugin, set the following attribute within the config.xml <system> section for the database.

Kleborate="yes"

Version 1.41.2

This version adds a choice of colour palettes to front-end and query dashboards.

Version 1.41.1

Adds support for defining colours for specific field values in dashboard visualisations.

You can define colours for values by field using an additional configuration file called dashboard_colours.toml that can be placed either
in /etc/bigsdb (for global use) or within a database configuration directory. The format is as follows:

 'eav_Bexsero_reactivity' = {
      'exact match'       = '#2ca02c',
      'cross-reactive'    = '#ff7f0e',
      'none'              = '#d62728',
      'insufficient data' = '#888888',
      'No value'          = '#aaaaaa'
 }
 'eav_Trumenba_reactivity' = {
      'exact match'       = '#2ca02c',
      'cross-reactive'    = '#ff7f0e',
      'none'              = '#d62728',
      'insufficient data' = '#888888',
      'No value'          = '#aaaaaa'
 }
 's_1_clonal_complex' = {
      'ST-11 complex'      = 'yellow',
      'ST-41/44 complex'   = 'green'
 }

Field names are prefixed as follows:

• f_ Standard provenance fields, e.g. f_country

• e_ Extended attribute fields, e.g. e_country||continent (continent attribute linked to country)

• eav_ :ref:Sparely-populated fields<sparsely_populated_fields>, e.g. eav_Bexsero_reactivity

• s_ Scheme fields, e.g. s_1_clonal_complex (clonal complex field in scheme 1)

This works for pie, doughnut, bar, and pie charts. Note that if you define any values for a field then any value not defined will be shown as light grey in the visualisation.

Version 1.40.1

Version 1.40.1 adds the following:

• Checks, and adds if necessary, field indexes on scheme field cache tables.
• As the scheme cache tables are not now re-created from scratch, it is necessary to check that the fields and field types match those in the scheme definition in case they have changed. If there are any mismatches, the scheme field cache table is dropped and recreated with a full refresh.
• New index added to the missing_loci field of the scheme cache. This speeds up a query used once for every isolate during scheme cache renewal.
• Sequence export with flanking regions has been fixed.
• --curator option added to autotag.pl and scannew.pl scripts.

Version 1.40.0

Cache renewal now uses an embedded database stored procedure for scheme field lookup, improving memory use.

Version 1.39.1

This version bring Improvements to scheme caching in isolate databases. This is now more scalable for large databases. Manually refreshing the scheme is now done in a forked process with updates displayed using AJAX calls.