Skip to content

Commit

Permalink
📝 update changelog, masterplan, tweak readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lenarddome committed Dec 22, 2021
1 parent 11f24d3 commit a8cf1e8
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
[![](https://cranlogs.r-pkg.org/badges/grand-total/psp)](https://cran.r-project.org/package=psp)
![CRAN/METACRAN](https://img.shields.io/cran/v/psp)
![CRAN/METACRAN](https://img.shields.io/cran/l/psp)
[![codecov](https://codecov.io/gh/lenarddome/psp/branch/main/graph/badge.svg?token=XS0CEOS74M)](https://codecov.io/gh/lenarddome/psp)

Parameter Space Partitioning MCMC for Global Model Evaluation (Pitt, Kim, Navarro
& Myung, 2006).
Expand Down Expand Up @@ -81,7 +80,6 @@ More about the architecture and coding styles will be added later.
- :heavy_plus_sign: Add dependency.
- :heavy_minus_sign: Remove dependency.


## About `psp`

- [A short intro and manual](https://lenarddome.github.io/software/psp/)
Expand Down
18 changes: 18 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,21 @@
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## [Unreleased]

### Added

- :gift: `psp` can now handle ordinal patterns other than strings of characters, e.g. adjacency matrices, list of strings, ...

### Changed

- :heavy_plus_sign: add `data.table` and `method` dependency
- add print method for new S3 `PSP` class

## v0.1

### First Official Stable Release

- stable 0.1 version release [available on CRAN](https://cran.r-project.org/package=psp)
- implements the parameter space partitioning algorithm described by Pitt, Kim, Navarro & Myung (2006)
12 changes: 12 additions & 0 deletions docs/MASTERPLAN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Planned Features

Currently, there are no additional features of parameter space partitioning
that can be implemented. Nonetheless, all suggestions are welcome. Keep in mind
that there are various features we will not be implementing - calculating volume
and burnout.

Some aspects of `psp` we would like to improve are:

- enhancing performance
- adding various statistics for summarizing `psp` results
- finding methods to visualise `psp` outputs

0 comments on commit a8cf1e8

Please sign in to comment.