obi

علم الوجود للتحقيقات الطبية الحيوية

يساعدك علم الوجود للتحقيقات الطبية الحيوية (OBI) على التواصل بوضوح حول التحقيقات العلمية من خلال تحديد أكثر من 2500 مصطلحًا للمقايسات والأجهزة والأهداف والمزيد.

هذا هو مستودع المطورين لـ OBI. يمكنك تنزيل أحدث منتجات OBI هنا ومعرفة المزيد حول OBI من خلال وثائقنا.

التحرير

مصطلحات الأنطولوجيا لدينا تأتي في ثلاث مجموعات. اعتمادًا على نوع المصطلح الذي تريد تعديله أو إضافته، يتعين عليك اتباع طرق مختلفة:

1. المصطلحات الخارجية (من الأنطولوجيات الأخرى): نستخدم OntoFox للواردات. قم بتحرير الملف src/ontology/OntoFox_inputs/ المقابل.

2. مصطلحات القالب: نستخدم قوالب ROBOT لتحويل جداول البيانات إلى OWL. قم بتحرير ملف src/ontology/templates/ ذي الصلة:

   • obsolete.tsv للمصطلحات القديمة
   • assays.tsv لفحوصات عامة
   • epitope-assays.tsv خصيصًا لفحوصات الحاتمة المناعية
   • value-specifications.tsv
   • specimens.tsv للعينات
   • medical-history.tsv لتصنيفات التاريخ الطبي ومعايير الاختيار ذات الصلة
   • study-designs.tsv لتصاميم الدراسة
   • data-sets.tsv لمجموعات البيانات

3. مصطلحات أخرى: تحرير src/ontology/obi-edit.owl في Protege.

انظر أدناه للحصول على قائمة كاملة بالملفات وتعليمات البناء وتعليمات حول استخدام Git وGitHub لـ OBI.

الاستيراد من الأنطولوجيا الجديدة

إذا كنت ترغب في استيراد مصطلحات من علم الوجود الذي لا يحتوي OBI حاليًا على ملف استيراد OntoFox ( src/ontology/OntoFox_inputs/ )، فاتبع الخطوات التالية:

1. اكتب ملف الاستيراد للأنطولوجيا الجديدة (انظر ملفات الاستيراد الموجودة كمرجع).
2. قم بتحديث catalog-v001.xml لسرد ملف الاستيراد الجديد كما يسرد ملفات الاستيراد الموجودة.
3. أضف عبارة استيراد إلى obi-edit.owl .
4. قم بإنشاء ملف فارغ لوحدة الإخراج في src/ontology/OntoFox_outputs/ ، على سبيل المثال، لإنشاء مخرجات زائفة لواردات foo.owl:

 touch src/ontology/OntoFox_outputs/foo_imports.owl

5. بناء الوحدة النمطية وobi.owl.

 make imports
make obi.owl

تحرير القوالب في Excel

إذا كنت ترغب في تحرير قالب أو قوالب في Excel، بدلاً من نسخ القالب ولصقه، فإننا نطلب منك اتباع سير العمل هذا للحفاظ على الاقتباس. يمكن أن يؤدي التنقل ذهابًا وإيابًا باستخدام Excel إلى حدوث بعض التغييرات غير المقصودة لعلامات الاقتباس المزدوجة داخل القوالب.

أولاً، قم بتثبيت متطلبات بايثون:

 python3 -m pip install -r requirements.txt

ثم قم بعمل ورقة Excel. في دليل OBI git المحلي لديك، قم بتشغيل الأمر التالي لإنشاء ملف يسمى obi.xlsx :

 make obi.xlsx

بعد ذلك، افتح obi.xlsx في Excel (أو أي محرر تفضله). يحتوي جدول البيانات هذا على علامة تبويب لكل قالب OBI (على سبيل المثال، "تصميم الدراسة"، "الاختبارات"، وما إلى ذلك). ابحث عن علامة التبويب التي تتوافق مع القالب الذي تريد تعديله، وقم بإجراء التغييرات، واحفظ جدول بيانات Excel في نفس الموقع ( obi.xlsx ). أخيرًا، قم بتشغيل ما يلي لتحديث إصدارات TSV من القوالب:

 make update-tsv

سيؤدي هذا إلى تحويل علامات التبويب الموجودة في obi.xlsx مرة أخرى إلى TSVs والكتابة فوق TSVs الموجودة في الدليل src/ontology/templates/ بالتغييرات التي أجريتها. قم بمراجعة تغييراتك ( git diff ) وقم بتقديم طلب السحب الخاص بك.

العثور على الشروط

للعثور على مكان وجود المصطلح، يمكنك استخدام src/scripts/locate.py .

ثم يمكنك تشغيل البرنامج النصي للعثور على المصطلحات حسب المعرف أو التسمية عن طريق تمريرها كقائمة مفصولة بمسافات، على سبيل المثال:

 src/scripts/locate.py OBI:0000070 CHMO:0000087 GO:0000785

يجب أن تكون التسميات محاطة بعلامتي اقتباس مزدوجتين:

 src/scripts/locate.py "assay" "fluorescence microscopy" "chromatin"

تحرير البرامج النصية المساعدة

يتضمن OBI repo بعض نصوص Python لمساعدة المطورين على تحرير قوالب obi-edit.owl وOBI بكفاءة. تتطلب هذه البرامج النصية Python 3.

تتطلب البرامج النصية أيضًا أن تقوم أولاً بإنشاء قاعدتي بيانات (واحدة من تحرير OBI، وواحدة من إصدار مدمج من OBI):

 make obi-dbs

شروط إعادة التسمية

نظرًا لاستخدام التصنيفات في القوالب، فقد يكون العثور على جميع استخدامات المصطلح واستبدالها يدويًا أمرًا صعبًا ومملًا. بدلاً من ذلك، يمكنك استخدام src/scripts/relabel.py لتحديث تصنيف المصطلح واستخداماته تلقائيًا.

يمكنك تشغيل هذا عن طريق تمرير المصطلح الذي تريد تحديثه والتسمية الجديدة:

 src/scripts/relabel.py CHMO:0000087 "microscopy with fluorescence"

يمكنك أيضًا تمرير التسمية القديمة باعتبارها الوسيطة الأولى، طالما أنها محاطة بعلامتي اقتباس مزدوجتين:

 src/scripts/relabel.py "fluorescence microscopy" "microscopy with fluorescence"

تأكد من الالتزام بجميع الملفات التي تم تغييرها لضمان تحديث جميع الاستخدامات.

ملفات

• README.md هذه الوثيقة العامة
• obi.owl هو الإصدار الأخير من OBI
• البرامج النصية Makefile لبناء OBI
• views/ وجهات النظر المتخصصة المختلفة لـ OBI
  • obi.obo هو الإصدار الأحدث من OBI بتنسيق ملف .obo
  • obi_core.owl الإصدار الأحدث من OBI Core: ~100 مصطلح رئيسي
• src/
  • ontology/ الملفات المصدرية لـ OBI
    • obi-edit.owl هو ملف OBI OWL الرئيسي
    • core.txt قائمة مصطلحات OBI الأساسية
    • external-byhand.owl بعض الواردات المخصصة من الأنطولوجيات الأخرى
    • catalog-v001.xml قائمة حرفية لتجاوزات استيراد OWL
    • templates/ ملفات قوالب ROBOT لمختلف فروع OBI
    • modules/ نتائج قوالب ROBOT
    • OntoFox_inputs/ ملفات التكوين OntoFox للاستيراد من الأنطولوجيات الأخرى
    • OntoFox_outputs/ ملفات النتائج OntoFox
  • استعلامات sparql/ SPARQL لبناء OBI والتحقق من صحته
  • scripts/ البرامج النصية فائدة
  • views/ تكوين طرق العرض

مبنى

يحتوي Makefile على نصوص برمجية لبناء OBI. في نظام التشغيل macOS أو Linux، يجب أن تكون قادرًا فقط على تشغيل make أو إحدى المهام المحددة أدناه. على نظام التشغيل Windows، فكر في استخدام نوع ما من أجهزة Linux الافتراضية مثل Docker أو Vagrant. ستكون معظم النتائج في دليل build/ . إذا كان لديك مشكلة، اتصل بجيمس.

• make test وتشغيل اختبارات SPARQL (يتم تشغيل هذا عند كل دفعة إلى GitHub)
• make sort ، وإصلاح علامات الاقتباس ونهايات الأسطر
• make imports تحديث واردات OntoFox
• make modules تقوم بتحديث قوالب ROBOT
• make obi.owl يبني ملف الإصدار؛ يمكن أن يستغرق التفكير حوالي 10 دقائق
• make views تحديث قوالب ROBOT
• make all للإصدار، وتشغيل imports ، modules ، test ، و obi.owl ، views
• make build/obi_merged.owl يدمج obi-edit.owl في ملف واحد، لا داعي لذلك
• make clean وإزالة الملفات المؤقتة

تطوير

نحن نستخدم git وGitHub لتطوير OBI. هناك الكثير من الوثائق الجيدة على حد سواء:

• موقع git مع الملفات والوثائق
• مساعدة جيثب والتدفق

الإعداد الأولي

قبل أن تتمكن من البدء في التطوير باستخدام OBI، ستحتاج إلى القيام ببعض الإعداد الأولي:

1. قم بالتسجيل للحصول على حساب جيثب

2. قم بتثبيت أداة سطر أوامر Git، أو تطبيق GitHub Desktop، أو عميل Git آخر من اختيارك

3. قم بتكوين Git باستخدام اسمك وبريدك الإلكتروني

4. استنساخ مستودع OBI

5. إذا كنت تستخدم macOS وExcel، فقم بإعداد ربط الالتزام المسبق (انظر أدناه للحصول على التفاصيل):

    ln -s ../../src/scripts/check-line-endings.sh .git/hooks/pre-commit
   

إجراء التغييرات

يجب إجراء التغييرات في أجزاء يمكن التحكم فيها، على سبيل المثال إضافة مصطلح واحد أو تعديل بعض المصطلحات ذات الصلة. يجب أن تتوافق معظم التغييرات مع مشكلة واحدة في جهاز التعقب.

ابدأ من نسخة محلية من الفرع master لمستودع OBI. تأكد من تحديث نسختك المحلية. قم بإجراء تغييراتك على فرع جديد. يرجى استخدام ورقة حجوزات معرف مصطلح OBI لإدارة المعرفات الجديدة.

عندما تكون جاهزًا، ادفع فرعك إلى مستودع OBI وقم بتقديم طلب سحب (PR) على موقع GitHub الإلكتروني. العلاقات العامة الخاصة بك هي طلب لدمج فرعك مرة أخرى في master . سيتم اختبار علاقاتك العامة ومناقشتها وتعديلها إذا لزم الأمر، ثم دمجها. ومن ثم يمكن تكرار الدورة للتغيير التالي الذي ستجريه أنت أو مطور آخر.

هذه هي الخطوات مع أوامر CLI الخاصة بهم. عند استخدام تطبيق واجهة المستخدم الرسومية، ستكون الخطوات هي نفسها.

1. git fetch تأكد من تحديث نسختك المحلية
2. git checkout master يبدأ في الفرع master
3. git checkout -b your-branch-name أنشئ فرعًا جديدًا يحمل اسم التغيير الذي تجريه
4. قم بإجراء التغييرات
5. make sort وتطبيع الجداول للحصول على اختلافات أنظف
6. تقوم git status و git diff بفحص التغييرات
7. git add --update src/ أضف جميع الملفات المحدثة في دليل src/ إلى التدريج
8. git commit --message "Description, issue #123" يلتزم بالتغييرات المرحلية مع رسالة؛ من الجيد تضمين رقم الإصدار
9. git push --set-upstream origin your-branch-name يدفع التزامك بـ GitHub
10. افتح https://github.com/obi-ontology/obi في متصفحك وانقر على زر "إجراء طلب سحب"

سيتم اختبار طلب السحب الخاص بك تلقائيًا. إذا كانت هناك مشاكل، فسوف نقوم بتحديث فرعك. عند اجتياز جميع الاختبارات، ستتم مراجعة العلاقات العامة الخاصة بك بواسطة مطوري OBI. عند اكتمال هذه المراجعة، سيقوم أحد كبار مطوري OBI بدمج العلاقات العامة. شطف وكرر!

حفظ الأشياء مرتبة

أسهل طريقة لتحرير ملفات src/ontology/template/ هي باستخدام Excel. لسوء الحظ، يحتوي برنامج Excel على بعض القواعد الفريدة لاقتباس قيم الخلايا، ويستخدم نظام التشغيل macOS نهايات الأسطر القديمة. كلا الأمرين يجعلان اختلافاتنا فوضوية ومربكة.

للحصول على فروق واضحة، نود أيضًا أن نمنع القوالب التي تم فرزها حسب المعرف. سيقوم أمر make sort بإصلاح نهايات الأسطر وفرزها عن طريق تشغيل جميع القوالب من خلال برنامج Python النصي.