هل يمكن لـ Roxygen تجاهل وظائف غير المستخدم؟
https://stackoverflow.com/questions/2316356
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russianسؤال
لقد بدأت للتو اللعب مع roxygen حزمة وأنا سعيد جدًا بالنتائج حتى الآن. ومع ذلك كنت أتساءل ، هل هناك طريقة لتحديدها roxygen يجب أن تتجاهل بعض الوظائف التي لا يمكن الوصول إليها؟
على وجه التحديد ، أفضل عدم الحصول على ملف .Rd يطفو على الملف لأنني أستخدم .onLoad() ربط في الحزمة الخاصة بي. تم توثيق هذه الوظيفة بالفعل في base حزمة لذلك لا يوجد سبب لإعادة توسيعها.
المحلول
حسنًا ، لقد وجدت أخيرًا وتصفحت قائمة Roxygen-Devel في ص فورج لمعرفة متى سيتم تنفيذ ذلك ، ويبدو أنه بالفعل في إصدار Roxygen الموجود على Cran. المفتاح هو تحديد use.Rd2=TRUE عند الاتصال roxygenize(). بموجب هذا الوضع ، سوف يتخطى Roxygen إنشاء وثائق لأي وظائف لا تسبقها تعليقات Roxygen.
نصائح أخرى
هذا مدرج في القائمة الخاصة بهم - في الإصدار التالي ، تعمل الوظائف فقط مع وثائق Roxygen على إنشاء ملفات رجل.
استخدم حقل الكلمات الرئيسية الداخلية (بمعنى آخر @keywords internal) لإزالة الوظيفة من الوثائق وجعلها متاحة للمستخدمين ذوي الخبرة فقط. مصدر: Roxygen2 المقالة القصيرة.
