मैं सहायक कार्यों के दस्तावेज़ीकरण को कैसे छिपा सकता हूं?

Question

मैं एक पैकेज बनाए रख रहा हूं जिसमें .rd फ़ाइलों के साथ दस्तावेज किए गए कई सहायक कार्य हैं। चूंकि उन्हें निर्यात नहीं किया जाता है, वे उपयोगकर्ताओं द्वारा आसानी से सुलभ नहीं होते हैं - यह अच्छा है। हालांकि, वे अभी भी पैकेज सहायता फ़ाइलों के सूचकांक में दिखाई देते हैं।

क्या इंडेक्स से दस्तावेज निकालने का कोई तरीका है ताकि यह अव्यवस्थित न हो, लेकिन help के माध्यम से अभी भी सुलभ हो?

Answer 1

आरडी फ़ाइल में एक फ़ील्ड है जिसे आप keywords कह सकते हैं। अधिकांश कीवर्ड एक उल्लेखनीय अपवाद के साथ कार्यों की खोज में सहायता के अलावा कुछ भी नहीं करते हैं: internal। आंतरिक कीवर्ड के साथ फ़ंक्शन को चिह्नित करना इसे इंडेक्स से हटा देता है। roxygen2 vignette के अनुसार:

@keywords keyword1 keyword2 ... मानकीकृत कीवर्ड जोड़ने के लिए। कीवर्ड वैकल्पिक हैं, लेकिन यदि मौजूद हैं, तो कीवर्ड विग्नेट में दोहराए गए पूर्वनिर्धारित सूची से लिया जाना चाहिए। @keywords internal को छोड़कर कीवर्ड बहुत उपयोगी नहीं हैं। आंतरिक कीवर्ड का उपयोग दस्तावेज सूचकांक से संबंधित आरडी फ़ाइल में सभी कार्यों को हटा देता है और उनके कुछ स्वचालित परीक्षण अक्षम करता है। एक सामान्य उपयोग केस दोनों को एक फ़ंक्शन निर्यात करना है (@export का उपयोग करके) और इसे आंतरिक के रूप में चिह्नित करना। इस तरह, उन्नत उपयोगकर्ता ऐसे फ़ंक्शन तक पहुंच सकते हैं जो नए उपयोगकर्ता इस बारे में उलझन में होंगे कि वे इसे इंडेक्स में देखना चाहते हैं या नहीं।

@keywords internal को रॉक्सीजन टिप्पणियों में जोड़ना वांछित परिणाम देगा।