Skip to content

Commit

Permalink
edit changelog to comply with the pkgdown guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
stolarczyk committed Feb 19, 2019
1 parent 8cf966b commit 2a5f00c
Showing 1 changed file with 15 additions and 17 deletions.
32 changes: 15 additions & 17 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,61 @@
# BiocProject Changelog
# BiocProject 0.1.1 - 2019-02-15

## [0.1.1] - 2019-02-15

### Added
## Added

* passes `BiocCheck`
* added option to specify additional arguments in the config file using a `funcArgs` subsection within the `bioconductor` section of the PEP config `yaml` file.

### Changed
## Changed

* now, any object can be returned by the data processing function, rather than requiring objects to inherit from `Annotated`
* when errors are encountered, BiocProject now returns a PEP (`pepr::Project`) along with the error message in a `S4Vectors::List` object
* the `bioconductor` section of the config file now follows the Bioconductor coding style (`camelCaps`)

## [0.1] - 2019-01-28
# BiocProject 0.1 - 2019-01-28

### Added
## Added

* methods: `is` (overwrites this method behavior just for the class `Annotated`), `.is.project`, `samples`, `config` for signature `Annotated`
* functions: `.insertPEP` and `BiocProject` (the workhorse of the package)

### Changed
## Changed

* **complete concept redesign**: no `BiocProject` class. The objects returned by the custom data reading function have to be of class `Annotated` and the `PEP` is inserted as the first element of its `metadata()` list

## [0.0.4] - 2019-01-25
# BiocProject 0.0.4 - 2019-01-25

### Changed
## Changed

* better custom data loading function error/warning communication
* all exceptions are caught with `BiocProject` constructor
* fix `.updateSubconfig(.Object@config, sp) : Subproject not found:` warning in `toProject` method

## [0.0.3] - 2018-12-21
# BiocProject 0.0.3 - 2018-12-21

### Changed
## Changed

* the default values for all optional arguments are `NULL`
* change `lambda function` to `anonymous function`

## [0.0.2] - 2018-12-01
# BiocProject 0.0.2 - 2018-12-01

### Changed
## Changed

* the object constructor does not fail if the `pepr::Project` object is provided in the `funcArgs` arguments list
* if the user-supplied function errors or throws a warning, appropriate messages are nicely displayed
* errors and warnings (if any) are returned instead of the data
* if the object constructor can't find the function file, the message is more informative

## [0.0.1] - 2018-11-20
# BiocProject 0.0.1 - 2018-11-20

### Added
## Added

* add `BiocProject::BiocProject` constructor function
* add `BiocProject::getData` method to extract the data from the object
* allow for passing additional arguments for user-provided functions in `BiocProject::BiocProject`
* allow to use lambda functions with `func` parameter

### Changed
## Changed

* make `BiocProject` class inherit from `pepr::Project` and `base::list`
* the `initialize` method can read in the data with the provided `func`
Expand Down

0 comments on commit 2a5f00c

Please sign in to comment.