CHANGES IN VERSION 2.24.0
-------------------------

BUG FIXES

    o Sanitize AnnotationHub resource filenames in annotation package creation with 'makeGScoresPackage()'.

CHANGES IN VERSION 2.16.0
-------------------------

USER VISIBLE CHANGES

    o Added support to the latest version v4.0 of gnomAD MAF data, stored in the package MafH5.gnomAD.v4.0.GRCh38.

    o Updated vignette to showcase the use of pathogenicity score sets from AlphaMissense, as well as the latest gnomAD v4.0 MAF data.

BUG FIXES

    o Bugfix in 'getGScores()' to properly handle resource license information.

CHANGES IN VERSION 2.14.0
-------------------------

USER VISIBLE CHANGES

    o Added four new pathogenicity score sets and corresponding metadata for hg19 and hg38: AlphaMissense.v2023.hg19, AlphaMissense.v2023.hg38, cadd.v1.6.hg19 and cadd.v1.6.hg38.

    o Updated vignette.

CHANGES IN VERSION 2.10.0
-------------------------

USER VISIBLE CHANGES

    o Added two new score sets and corresponding metadata for mm39: phastCons35way.UCSC.mm39 and phyloP35way.UCSC.mm39.

    o Added new method 'wgscores()' to find which genomic scores are present in a given set of genomic ranges. Feature request by https://github.com/rcastelo/GenomicScores/issues/20

    o Improved error messages about optional arguments without name or with a mispecified name in the call to 'gscores()'.

BUG FIXES

    o Bugfix for parameters 'ref' and 'alt' when used with HDF5 backends.

CHANGES IN VERSION 2.8.0
------------------------

USER VISIBLE CHANGES

    o Added support to the latest version 3.1.2 of gnomAD MAF data, stored in the package MafH5.gnomAD.v1.1.2.GRCh38.

BUG FIXES

    o Bugfix on a problem caused by unordered input genomic ranges of width larger than 1, whose result was return in the wrong order; see https://github.com/rcastelo/GenomicScores/issues/18

    o Bugfix when accessing multiple populations of scores stored on an HDF5 backend.

CHANGES IN VERSION 2.4.0
------------------------

USER VISIBLE CHANGES

    o The gscores() function now returns the SeqInfo from the input GScores object.

    o Improvements on the shiny web app.

CHANGES IN VERSION 2.0.0
------------------------

USER VISIBLE CHANGES

    o Added a shiny app available through the function 'igscores()'.

    o Added support for genomic score packages (e.g., MafH5.*) that use HFD5 files as a backend.

    o Added a new function 'rgscores()' for randomly sampling genomic scores.

CHANGES IN VERSION 1.10.0
------------------------

USER VISIBLE CHANGES

    o Added support to latest release 3.0 of gnomAD MAF data, stored in the package MafDb.gnomAD.r3.0.GRCh38.

    o Individual allele frequencies can be now retrieved from MafDb.* packages when 'ref' and 'alt' arguments are given to the functions 'gscores()' and 'score()'. See manual pages and vignette for further details.

    o NonSNRs are now searched giving the argument type="equal" to findOverlaps(). This means that only scores from exact matches to nonSNRs are returned.

BUG FIXES

    o Bugfix on the 'getGScores(') function that precluded accessing the files downloaded by the AnnotationHub

    o Bugfix in accessing MAF values from nonSNVs when multiallelic variants are stored in different records from the VCF file.

CHANGES IN VERSION 1.8.0
------------------------

USER VISIBLE CHANGES

    o Added support to latest release 2.1 of gnomAD MAF data lifted to GRCh38 by Ensembl, stored in packages MafDb.gnomAD.r2.1.GRCh38 and MafDb.gnomADex.r2.1.GRCh38.

BUG FIXES

    o Bugfix in the support to TOPMED MAF data, to discard variants whose VCF FILTER is not set to PASS.

CHANGES IN VERSION 1.6.0
------------------------

USER VISIBLE CHANGES

    o Functions and classes deprecated in the previous release (scores, MafDb class) have been now removed from the package.

    o Added support to latest release 2.1 of gnomAD MAF data, stored in packages MafDb.gnomAD.r2.1.hs37d5 and MafDb.gnomADex.r2.1.hs37d5.

CHANGES IN VERSION 1.4.0
------------------------

USER VISIBLE CHANGES

    o The function 'scores()' has been deprecated and replaced by the function 'gscores()'.

    o The argument 'scores.only' in the function 'scores()' has been deprecated and replaced by calling the function 'score()'.

    o The 'MafDb' class has been deprecated and now the 'GScores' class supports former 'MafDb' objects. The 'mafByOverlaps()' and 'mafById()' functions have been deprecated and replaced by the function 'gscores()'. The 'populations()' function from the 'MafDb' API has been integrated into the 'GScores' API.

    o Added metadata on genomic scores categories, available through the function 'gscoresCategory()', on availability of non-single nucleotide regions through the function 'gscoresNonSNRs()', and on the default population used through the function 'defaultPopulation()'.

    o New AnnotationHub resources have been added during this release cycle: phyloP60way.UCSC.mm10, LINSIGHT, phastCons46wayPlacental, phastcons46wayPrimates.

    o Added a BiocSticker at https://github.com/Bioconductor/BiocStickers/tree/master/GenomicScores

    o Added citation information after package publication has been accepted at Bioinformatics.


CHANGES IN VERSION 1.2.0
------------------------

USER VISIBLE CHANGES

    o Added methods 'name()' and 'type()' for GScores objects.

    o Enabled the retrieval of multiple score values per genomic position (e.g., as in CADD or M-CAP scores).

    o Added method 'citation()' to fetch citation information for genomic scores.

    o Added function 'makeGScoresPackage()' to create an annotation package from an AnnotationHub genomic scores resource.

    o Added 'qfun()' and 'dqfun()' methods to fetch the quantization and dequantization functions from used to store and retrieved genomic scores.

    o Added 'quantized' argument to the 'scores()' method to obtain quantized values if the user wants to dequantize the values him or herself.

    o Fallback to local AnnotationHub when there is no internet connection to fetch genomic scores through AnnotationHub resources.

    o Added 'MafDb' class, derived from 'GScores' to store and access minor allele frequency values. This was originally defined in the 'VariantFiltering' package.

    o The vignette has been updated to illustrate the use of some of the previous changes.

CHANGES IN VERSION 0.99.0
-------------------------

USER VISIBLE CHANGES

    o Submission of the first version to the Bioconductor project.

(start date: March 17, 2017)
