آمانات رمز الرود / أفضل الممارسات

https://stackoverflow.com/questions/1905258

19-09-2019
|

سؤال

أنا جديد في ص ووجه صعوبة في تفكيك المعلومات من المصادر المختلفة عبر الإنترنت المتعلقة بما يعتبر ممارسة "جيدة" مع رمز القرص R. لقد قرأت أدلة أساسية لكنني كنت أعاني من صعوبة في العثور على المعلومات التي هي بالتأكيد حتى الآن.

ما هي بعض الأمثلة على فئات S3 مكتوبة جيدا / موثقة؟
ماذا عن فصول S4 المقابلة؟
ما هي الاتفاقيات التي تستخدمها عند التعليق .R .R فصول / وظائف؟ هل وضعت كل تعليقاتك في كل من ملفات .rd وملفات .r؟ هو مزامنة هذه الملفات متعبة؟

المحلول

سواء لاستخدام S3 أو S4 أو حزمة على الإطلاق هي في الغالب مشكلة أسلوب (كما يقول ديرك)، لكنني أقترح استخدام أحد تلك إذا كنت ترغب في الحصول على كائن منظم جيد للغاية (تماما كما تفعل في أي لغة OOP ). على سبيل المثال، تحتوي جميع فئات السلسلة الزمنية على كائنات مسلسلات زمنية (أعتقد أنهم جميعا S3 باستثناء إنه) لأنه يسمح لهم بتنفيذ سلوك معين حول بناء واستخدام هذه الكائنات. وبالمثل، مع سؤال حول إنشاء حزمة: من الجيد القيام بذلك إذا كنت ستتم إعادة استخدام الرمز الخاص بك بشكل متكرر أو إذا كان الرمز سيكون مفيدا لشخص آخر. يتطلب المزيد من الجهد قليلا، لكن الهيكل التنظيمي المضافة يمكن بسهولة الحصول على التكلفة.

فيما يتعلق S3 مقابل S4 (ناقش على مساعدة R-Help هنا و هنا)، والمبدأ التوجيهي الأساسي هو أن فصول S3 أكثر "سريع و قذر" بينما S4 فصول مكان أكثر السيطرة الصلبة على الكائنات والأنواع. وبعد إذا كنت تعمل على موصل الموصل الأحيائي، فسوف تستخدم عادة S4 (انظر، على سبيل المثال، "فصول وأساليب S4").

أوصي بقراءة بعض ما يلي:

بالنسبة للوثائق، فإن اقتراح هادلي هو المكان على: سوف يجعل Roxygen الحياة أسهل ويبلغ الوثائق بجوار التعليمات البرمجية. جانبا، قد لا تزال ترغب في تقديم تعليقات أخرى في التعليمات البرمجية الخاصة بك وراء - فى الجانب الاخر ما الذي تتطلبه Roxygen أو ملفات الرجل، في هذه الحالة، من الممارسات الجيدة التعليق على التعليمات البرمجية الخاصة بك للمطورين الآخرين. هذه التعليقات لن تنتهي في الحزمة الخاصة بك؛ سيكونون مرئيين فقط في التعليمات البرمجية المصدر.

نصائح أخرى

ل 3. استخدام Roxygen - إنه يعمل مثل Javadoc لاتخاذ تعليقات في ملفات المصدر الخاصة بك وبناء ملفات RD.

هذا هو نصف دزينة أو أكثر من الأسئلة المجمعة في واحدة، مما يجعل من الصعب الإجابة.

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

الكثير من الباقي هو أسلوب. أقسم بعض رموز ص بارزة عن طريق S4، بينما أقسم آخر. يمكنك دائما قراءة حزم الآخرين وكذلك الرمز في R نفسه. ويمكنك دائما إعادة تنفيذ ملف RODBC الخاص بك بطرق مختلفة ومقارنة مناهجك الخاصة.

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

إلى حد ما أكثر النمط يتعلق بالمادة، ولكن دليل أسلوب جوجل يستحق القراءة:

مرخصة بموجب: CC-BY-SA مع الإسناد

لا تنتمي إلى StackOverflow