अपने डेटा से लिखें
विश्लेषण इनपुट, स्क्रिप्ट, तालिकाओं और पांडुलिपि के परिणामों को आपस में जुड़े रखें।
किसी परिणाम अनुच्छेद पर भरोसा करना आसान हो जाता है जब उसके पीछे की गणना पास में मौजूद हो। विश्लेषण प्रक्रिया और उसके आउटपुट को पांडुलिपि के साथ रखने के लिए एक शोध प्रोजेक्ट का उपयोग करें।
प्रोजेक्ट सेट अप करें
“प्रोजेक्ट सेट अप करें” शीर्षक वाला अनुभागReproducible analysis स्टार्टर चुनें। डेटा फ़ोल्डर लिंक करें ताकि शोध टूल मूल मापों को पढ़ सकें, उन्हें पेपर में ले जिए बिना।
विश्लेषण की माँग करने से पहले दर्ज करें कि कॉलम का क्या अर्थ है, उनकी इकाइयाँ क्या हैं, और कोई बहिष्करण तो नहीं है।
असिस्टेंट को एक सीमित कार्य दें
“असिस्टेंट को एक सीमित कार्य दें” शीर्षक वाला अनुभाग/oleafly-data-analysis का उपयोग करें या एक Analysis शोध कार्य लें:
लिंक किए गए Data फ़ोल्डर के मापों को पढ़ें। analysis-plan.md में दी गई विधि से दोनों शर्तों की तुलना करें। स्क्रिप्ट, इकाइयों के साथ एक तालिका, और बहिष्करण बताने वाला एक नोट सहेजें। इनपुट डेटा बिना बदले रखें।
विश्लेषण स्क्रिप्ट के लिए ज़रूरी लोकल रनटाइम और लाइब्रेरीज़ चाहिए। असिस्टेंट से कहें कि वह इन ज़रूरतों की जाँच करे और यह भी सहेजे कि यह काम दोबारा कैसे चलाया जाए।
आउटपुट की जाँच करें
“आउटपुट की जाँच करें” शीर्षक वाला अनुभागस्क्रिप्ट पढ़ें और पक्का करें कि चुना गया डेटा और विधि प्रश्न से मेल खाते हैं। कोई परिणाम मानने से पहले इकाइयाँ, नमूनों की संख्या, गायब मान और अनिश्चितता जाँचें।
तालिकाओं और आकृतियों को उन्हें बनाने वाली स्क्रिप्ट के साथ रखें। figure-prep स्किल जाँचा हुआ परिणाम पांडुलिपि के लिए आकृति में बदलने में मदद कर सकती है।
किसी CLI एजेंट के साथ, Reproducibility audit स्टार्टिंग पॉइंट यह पूछता है कि किसी परिणाम को दोबारा बनाने के लिए अभी क्या चाहिए: कोड, डेटा, सॉफ़्टवेयर संस्करण, रैंडम सीड और बिल्ड निर्देश। Figure audit कैप्शन, लेबल, अक्ष की इकाइयाँ और पठनीयता जाँचता है। दोनों एजेंट से कहते हैं कि वह research/ में एक रिपोर्ट लिखे और पांडुलिपि को जस का तस रखे।
दस्तावेज़ के अंदर कोड चलाएँ
“दस्तावेज़ के अंदर कोड चलाएँ” शीर्षक वाला अनुभागPDF की संख्याएँ सीधे कोड से आएँ, इसके लिए रिपोर्ट Quarto या Calepin में लिखें। Quarto, .qmd या .Rmd फ़ाइल में R, Python या Julia चंक चलाता है, और Calepin Typst दस्तावेज़ में चंक चलाता है।
- हर प्रोजेक्ट में कोड तब तक बंद रहता है जब तक आप Allow code in this project न चुनें। कोड बंद होने पर Quarto हर चंक का कोड उसके आउटपुट के बिना दिखाता है, और Calepin वे नतीजे दिखाता है जो उसने पिछली बार कोड चलने पर सहेजे थे। फ़िल्टर, शॉर्टकोड,
_extensionsफ़ोल्डर, रेंडर स्क्रिप्ट और इनलाइन R कोड तब भी कोड चलाते हैं, इसलिए जो प्रोजेक्ट इनमें से किसी का इस्तेमाल करता है, वह कोड की अनुमति दिए बिना कंपाइल नहीं होगा। - कोड बंद हो और कंप्यूटर पर R न हो, तब भी फ़्रंट मैटर वाली
.qmdफ़ाइल का प्रीव्यू बनता है, जब तक उसके फ़्रंट मैटर मेंknitr:कुंजी न हो। R कोड वाले किसी भी दूसरे दस्तावेज़ को,.Rmdफ़ाइलों समेत, कोड बंद होने पर भी R चाहिए। R को cloud.r-project.org (नए टैब में खुलता है) से इंस्टॉल करें, फिर दोबारा कंपाइल करें। - Oleafly को Quarto 1.5 या नया चाहिए। अगर आपका पुराना है, तो Oleafly अपनी प्रति इस्तेमाल करता है, या आपसे Settings → Engines → Quarto से एक डाउनलोड करने को कहता है। कोई प्रति डाउनलोड न हो, तो
_quarto.ymlप्रोजेक्ट का दस्तावेज़ आपके पुराने Quarto से ही बनता है। - Python कोड प्रोजेक्ट के अपने एनवायरनमेंट में चलता है, जब प्रोजेक्ट में
.venv,venvयाenvफ़ोल्डर हो जिसमें Jupyter इंस्टॉल हो, और Calepin प्रोजेक्ट में.venvफ़ोल्डर हो तो उसे इस्तेमाल करता है। वरना कोड उस Python में चलता है जो Settings → Engines → Quarto में Languages के नीचे सूचीबद्ध है। pdfयाbeamerदस्तावेज़ को LaTeX चाहिए। TeX इंस्टॉल न हो, तो Oleafly जब TinyTeX इंस्टॉल करने का प्रस्ताव दे तब उसे इंस्टॉल करें, दस्तावेज़ कोformat: typstपर ले जाएँ, या कोड की अनुमति मिल जाने पर बिल्ट-इन इंजन इस्तेमाल करने के लिए फ़्रंट मैटर मेंpdf-engine: tectonicजोड़ें।- Quarto दस्तावेज़ के नाम से उसके बगल में एक वर्किंग फ़ाइल लिखता है: PDF के लिए
report.tex, या Typst के लिएreport.typ। अगर आपकी किसी फ़ाइल का यही नाम पहले से है, तो कंपाइल रुक जाता है और उसे बदलने के बजाय उसका नाम बताता है। अपनी फ़ाइल का नाम बदलें या उसे कहीं और ले जाएँ, फिर दोबारा कंपाइल करें। - अगर PDF से कोरियाई, चीनी या जापानी अक्षर ग़ायब हों, तो चेतावनी एक फ़ॉन्ट का नाम बताती है और फ़्रंट मैटर में जोड़ने के लिए दो पंक्तियाँ देती है: उस फ़ॉन्ट के साथ
CJKmainfont:, औरpdf-engine: tectonic। दोनों जोड़ें, क्योंकि फ़ॉन्ट बिल्ट-इन इंजन के साथ आता है।pdf-engine: tectonicतभी काम करता है जब प्रोजेक्ट के लिए कोड की अनुमति दी जा चुकी हो। - एक नोटबुक एक घंटे तक चल सकती है। उसके बाद Oleafly उसे रोक देता है, और लॉग दिखाता है कि वह किस सेल तक पहुँची। उस सेल को छोटा करें या कैश करें, फिर दोबारा कंपाइल करें।
परिणाम लिखें
“परिणाम लिखें” शीर्षक वाला अनुभागअसिस्टेंट से कहें कि वह केवल समीक्षित आउटपुट से परिणामों का एक अनुच्छेद लिखे। हर संख्या को तालिका से मिलाकर देखें और विधि को व्याख्या से अलग रखें।
दस्तावेज़ कंपाइल करें और PDF में पूरी तालिका या आकृति की समीक्षा करें, लेबल और कैप्शन सहित।