clulab / reach

Reach Biomedical Information Extraction
Other
96 stars 39 forks source link

Update bioresources documentation and remove deprecated files #768

Closed bgyori closed 2 years ago

bgyori commented 2 years ago

This PR updates the README for bioresources with up-to-date instructions for how resources can be extended. As far as I could tell, the following files/code were deprecated and are removed by this PR:

Let's see if any tests fail after these changes, I can revert some removals if they are in fact being used.

MihaiSurdeanu commented 2 years ago

Thanks @bgyori !

@kwalcock : can you please check on the compilation issues here?

MihaiSurdeanu commented 2 years ago

@enoriega : are the instructions in the modified README here correct? Thanks!

bgyori commented 2 years ago

According to the Jenkins logs, tests are still referring to the configured file names in ReachKBConstants - perhaps in this case it would be reasonable to modify the tests?

MihaiSurdeanu commented 2 years ago

Yep!

kwalcock commented 2 years ago

As @bgyori probably saw:

[error] /var/jenkins_home/workspace/reach_bioresources_docs/main/src/test/scala/org/clulab/reach/TestComplexResolutions.scala:89:23: not found: value StaticProteinFamilyOrComplexFilename
[error] Error occurred in an application involving default arguments.
[error]     kbFilename = Some(StaticProteinFamilyOrComplexFilename),
[error]                       ^
[error] /var/jenkins_home/workspace/reach_bioresources_docs/main/src/test/scala/org/clulab/reach/TestFamilyResolutions.scala:348:23: not found: value StaticProteinFamily2Filename
[error] Error occurred in an application involving default arguments.
[error]     kbFilename = Some(StaticProteinFamily2Filename),
[error]                       ^
[error] /var/jenkins_home/workspace/reach_bioresources_docs/main/src/test/scala/org/clulab/reach/TestFamilyResolutions.scala:363:23: not found: value StaticProteinFamilyOrComplexFilename
[error] Error occurred in an application involving default arguments.
[error]     kbFilename = Some(StaticProteinFamilyOrComplexFilename),
[error]                       ^
[error] /var/jenkins_home/workspace/reach_bioresources_docs/main/src/test/scala/org/clulab/reach/TestOrganResolutions.scala:71:49: not found: value ContextOrganFilename
[error] Error occurred in an application involving default arguments.
[error]   val meta = new IMKBMetaInfo(kbFilename = Some(ContextOrganFilename))
[error]                                                 ^
[error] /var/jenkins_home/workspace/reach_bioresources_docs/main/src/test/scala/org/clulab/reach/TestProteinResolutions.scala:21:36: not found: value StaticProteinFilename
[error]   val imkbP0F = new TestProteinKBL(StaticProteinFilename)          // defined after this class (LOOK BELOW)
[error]                                    ^
[error] /var/jenkins_home/workspace/reach_bioresources_docs/main/src/test/scala/org/clulab/reach/TestProteinResolutions.scala:22:36: not found: value StaticProteinFilename2
[error]   val imkbPGP = new TestProteinKBL(StaticProteinFilename2)
[error]                                    ^
[error] /var/jenkins_home/workspace/reach_bioresources_docs/main/src/test/scala/org/clulab/reach/TestProteinResolutions.scala:23:36: not found: value StaticProteinFilename3
[error]   val imkbPQZ = new TestProteinKBL(StaticProteinFilename3)
[error]                                    ^
[error] /var/jenkins_home/workspace/reach_bioresources_docs/main/src/test/scala/org/clulab/reach/TestTsvKBs.scala:118:23: not found: value StaticCellLocation2Filename
[error] Error occurred in an application involving default arguments.
[error]     kbFilename = Some(StaticCellLocation2Filename),
[error]                       ^
[error] /var/jenkins_home/workspace/reach_bioresources_docs/main/src/test/scala/org/clulab/reach/TestTsvKBs.scala:128:23: not found: value StaticProteinFamily2Filename
[error] Error occurred in an application involving default arguments.
[error]     kbFilename = Some(StaticProteinFamily2Filename),
[error]                       ^
[error] 9 errors found
bgyori commented 2 years ago

So I think the tests could be changed to read the same file paths from application.conf instead of the redundant variable declarations in ReachKBConstants, I'm just not sure how to best implement that in Scala. Would @enoriega or @kwalcock be able to help with that? Thanks!

enoriega commented 2 years ago

I'll take care of it

MihaiSurdeanu commented 2 years ago

Thanks @enoriega !

kwalcock commented 2 years ago

Thanks for beating me to it, @enoriega.

enoriega commented 2 years ago

The changes to README.md are accurate.

MihaiSurdeanu commented 2 years ago

Cool, thanks!

enoriega commented 2 years ago

Looks fine now. Do you want to take a quick look into the tests before merging? @kwalcock