كيفية الإسناد الترافقي لمعادلة في ملف تعليمات R/roxygen2

Question

أنا بصدد توثيق بعض وظائفي لحزمة R التي أقوم بإنشائها.

أنا أستخدم ترميز roxygen، على الرغم من أن هذا لا علاقة له بسؤالي إلى حد كبير.

لقد وضعت المعادلات في الوثائق الخاصة بي باستخدام \deqn{...}.سؤالي هو:هل هناك طريقة للإشارة إلى هذه المعادلة لاحقًا؟

على سبيل المثال، في ملف Rd الخاص بي:

\deqn{\label{test}
 y = mx + b
}

هل يمكنني لاحقًا القيام بشيء مثل:

بالإشارة إلى المعادلة ef{test}، ...

لقد حاولت \eqref{test}, \ref{test} (والتي تحصل على "ماكرو غير معروف" ولا يتم ربطهما)، وأيضًا \link{test} (الذي يشكو من عدم تمكنه من العثور على الوظيفة test لأنه في الواقع مخصص فقط للربط بوظائف أخرى).

وإلا أخشى أنني قد أضطر إلى القيام بشيء متسلل وإضافته إلى ملف -- (1) و Refer to equation (1) يدويا في حدود \deqn الخ في ملف Rd ...

تحديث

يبدو أن الإجابة العامة هي "لا".(أووو...)

ومع ذلك، يمكنني كتابة المقالة القصيرة واستخدام اللاتكس/الحزم "العادية" هناك.على أية حال، لقد لاحظت للتو أن معادلات المصفوفة التي قضيت وقتًا طويلًا في وضعها في ملف roxygen/Rd الخاص بي تبدو فظيعة في ?myFunction نسخة من المساعدة (تظهر كمصدر لاتكس حرفي).وهو أمر مؤسف، لأنها تبدو جميلة في نسخة المساعدة بصيغة pdf.

أشار @Iterator إلى وجود نص مشروط, ، لذا سأقوم بإجراء عمليات حسابية بتنسيق ASCII في ملفات .Rd، ولكن عمليات حسابية من مادة اللاتكس في دليل/المقالة القصيرة بتنسيق pdf.

Answer 1

أقوم بتجميع تعليقاتي أعلاه في إجابة لصالح الآخرين.

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

البديل هو الاستخدام المقالات القصيرة الحزمة, أو حتى الوثائق المستضافة خارجيًا (كما يفعل هادلي ويكهام بالنسبة لبعض حزمه).سيسمح لك هذا باستخدام ملفات PDF أو وثائق أخرى حسب رغبتك.بهذه الطريقة، يمكنك تضمين لقطات الشاشة، والمؤامرات، وجميع امتدادات LaTeX الأكثر مرحًا والتي لا يمتلكها أحد سواك، والأهم من ذلك، امتدادات AMS التي نعرفها ونحبها جميعًا.

ومع ذلك، يمكن للمرء تحديد عرض مختلف لقسم معين من الوثائق (بتنسيق .Rd) استنادًا إلى الواجهة، مثل نص وحدة التحكم، والأحرف اللطيفة لـ HTML، وما إلى ذلك، و نص مشروط يدعم هذا النوع من الاختلاف في التنسيق.

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