Skip to content

Commit

Permalink
update changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
geritwagner committed Nov 12, 2021
1 parent 822f2a4 commit 0268415
Showing 1 changed file with 26 additions and 19 deletions.
45 changes: 26 additions & 19 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0).

### Added

- `initialize` to set up the data directory (including a `readme.md` and the `search_details.csv`)
- `merge_duplicates` with automated (threshold-based) and semi-automated identification of duplicates
- `sample_profile` to generate a csv of the sample and to cross-tabulate journals vs years
- Use of submodules for crowd-sourced data
- Checks whether the hash_id function is up-to-date with the commit-id in the `.pre-commit-config.yaml`
- `analysis/fix_errors.py` to fix missing hash_ids and to rename propagated citation_keys
- `analysis/renew_hash_id_function.py` to keep track of hash functions and commit ids of pipeline_validation_hooks in `analysis/hash_function_pipeline_commit_id.csv`
- `analysis/trace_search_result.py` to trace search records (in BibTeX format)
### Changed

### Removed

### Fixed

### [0.2.0] - 2021-09-12

### Added

- Status model (rev_status, md_status, pdf_status)
- Implemented cli interface
- Import formats (bib, ris, endn, pdf, text list of references)
- Docker services for import, ocr, building the paper etc.
- Metadata repositories for record preparation (crossref, dblp, semantic scholar)
- PDF preparation (OCR, metadata validation)
- Commit message reporting
- Check and validation of iteration completeness
- Support for building papers based on pandoc

### Changed

- Changed environment to Docker-compose and revised Makefiles to call scripts within Docker containers
- Refactored code, including `analysis/utils.py/load_references_bib(modification_check, initialize)` and `analysis/utils.py/git_modification_check(filename)`
- Improve treatment of diacritics and accents when generating citation_keys in `analysis/cleanse_records.py`
- `backward_search` now works with tei-conversion provided by a grobid Docker container
- Update `utils.py/save_bib()` and pre-commit hook/formatter
- Updated `analysis/cleanse_records.py` based on derek73/python-nameparser
- Updated `analysis/combine_individual_search_results.py`, `analysis/merge_duplicates.py`
- Update hash_id function
- Updated path handling (`analysis/config.py`)
- Renaed `analysis/combine_individual_search_results.py` to `analysis/importer.py`
- Integrated review process status (including prescreen, screen inclusion vs exclusion) in the references.bib
- Renamed scripts and cli entrypoints
- Refactored code
- Tracing from hash_id to origin links
- Extended and refactored pre-commit hooks

### Removed

- R scripts for sample statistics (the goal is to implement them in Python)
- hash_id function, trace_entry, trace_hash_id

### Fixed

Expand All @@ -43,7 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0).
- Exception in `anaylsis/screen_2.py` (IndexError)
- Global constant conflict with `analysis/entry_hash_function.py` (nameparser.config/CONSTANTS)

### [0.1.0] -2021-05-08
### [0.1.0] - 2021-05-08

### Added

Expand Down

0 comments on commit 0268415

Please sign in to comment.