search

clamsproject / aapb-annotations

Repository to store manual annotation dataset developed for CLAMS-AAPB collaboration
3 stars 0 forks source link

Update repo readme to ver:b.b #37

Closed jarumihooi closed 10 months ago

jarumihooi commented 10 months ago

fixes partially #35 by adding a repository readme with signficantly more information, however still requires update for bullets noted in issue 35 such as time format consistency.

keighrim commented 10 months ago

Overall looks good and read well. I made a new commit to separate time format recommendation as a separate section. Feel free to edit further, or merge as is.

jarumihooi commented 10 months ago

Great, I agree above. This may seem a little odd to say, but in the interest of adhering to the principle of "slowing reflecting maturity of documentation", I'm going to say we should let me focus on the already large set of changes needed to be made here and get a new working version up. Piling on more is beginning to magnify complexity.

Let aim to get to a release version soon first.

jarumihooi commented 10 months ago

We had a zoom meeting to discuss remaining issues: Conversation was to improve these areas:

"Batches/Events" - split explanantion of this. batches exist. then we pick one for an event of annotation.

Remove "replicability" - "This section should give sufficient documentation for how the annotation was done and the conditions/assumptions under which the dataset exists."

Rephrase the organizations in the beginning (bring back aapb full name) .

keighrim commented 9 months ago

This PR was merged, then the main history was re-written after that, obsoleting the history in this PR. See #49 for overwriting PR.