Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docanalysis README.md seems to have an error #27

Open
EmanuelFaria opened this issue Dec 20, 2022 · 1 comment
Open

docanalysis README.md seems to have an error #27

EmanuelFaria opened this issue Dec 20, 2022 · 1 comment

Comments

@EmanuelFaria
Copy link
Collaborator

Under the heading "Extract Abbreviations" the example code (I think, because it didn't work) points to a directory that is not related to the other examples provided:
docanalysis --project_name corpus\ethics_10 --output dict_search_5.csv --make_json dict_search_5.json --make_ami_dict entities --extract_abb ethics_abb

Is it trying to find a directory named "corpus" and then being tasked to create a sub-folder within it called "ethics_10"? There is no mention of this in the instructions. Please correct as necessary.

Suggestion: explain the example commands above them.

  • There's no explanation of how/why a .json file could be useful, as opposed to csv which a larger population of users would understand.
  • Also, why is the output file named "ethics_abb"? the example dictionary provided below the example command doesn't seem to have anything to do with ethics. See below:
<dictionary title="ethics_abb">
  <entry name="ASD" term="Atrial septal defect"/>
  <entry name="SPSS" term="Statistical Package for Social Sciences"/>
  <entry name="ACGME" term="Accreditation Council of Graduate Medical Education"/>
  <entry name="ABP" term="American Board of Paediatrics"/>
  <entry name="TBL" term="Team Based Learning"/>
  <entry name="TBL" term="Team-Based Learning"/>
  <entry name="UNTH" term="University of Nigeria Teaching Hospital"/>
  <entry name="PAH" term="pulmonary hypertension"/>
  <entry name="HREC" term="Human Sciences Research Council, Research Ethics Committee"/>
  <entry name="HREC" term="Human Sciences Research Council, Research Ethics Committee"/>
  <entry name="CDC" term="Center for Disease Control and Prevention"/>
  <entry name="ASD" term="Atrial septal defect"/>
  <entry name="PAH" term="pulmonary arterial hypertension"/>
  <entry name="CVDs" term="cardiovascular diseases"/>
  <entry name="BNs" term="Bayesian networks"/>
  <entry name="GI" term="gastrointestinal cancer"/>
  <entry name="ART" term="antiretroviral therapy"/>
  <entry name="HIV" term="human immunodeficiency virus"/>
  <entry name="GATE" term="Global Cooperation on Assistive Technology"/>
</dictionary>
@ShweataNHegde
Copy link
Collaborator

The README is a bit outdated. The Wiki page is a bit more extensive and up-to-date. Check it out, here: https://github.com/petermr/docanalysis/wiki/docanalysis-Tutorial

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants