OHDSI / OHDSI/FeatureExtraction

Provide a more informative error when the `checksum` fails onLoad of FeatureExtraction

Open
#291 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
R
Stars
74
Forks
63
PR merge metrics
No merged PRs in 30d

Description

When the Java library for FeatureExtraction is updated, you must update the inst/csv/jarChecksum.txt which is done through:

https://github.com/OHDSI/FeatureExtraction/blob/437570aa6a955486f9a4ab5917d64ac857971ed4/extras/PackageMaintenance.R#L86-L88

If you do not update the inst/csv/jarChecksum.txt, you get the following error:

https://github.com/OHDSI/FeatureExtraction/blob/437570aa6a955486f9a4ab5917d64ac857971ed4/R/FeatureExtraction.R#L42-L46

It would be useful to update this description to include some information for Java developers to indicate that the origin of this error lies with a mismatch between the inst/csv/jarChecksum.txt and current state of the FE Java library.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in R/FeatureExtraction.R at lines 42-46 and review the checksum failure, then compare it with inst/csv/jarChecksum.txt and the update process in extras/PackageMaintenance.R at lines 86-88. Done means the error explains to Java developers that the checksum file can mismatch the current FeatureExtraction Java library.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, r
Domain
developer-experience
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.