2012-05-04 6 views
9

R'de işlev önkoşulları ve son durumları kontrol etmek ve belgelemek için deyimsel yol nedir? Burada sanatın lar in ve out blok devlet Eiffel 'require ve ensure yapılara veya D inşa s' dikkate alacağını, ancak çoğu diller bunlar yaklaşık olarak ifade etmek o kadar gelişmiştir iyi uygulamalar pişmiş yok. varsayımlar içinde geçirilen işlevler uymayan verileri. Şu anda fonksiyonun başlangıcında aklınıza gelebilecek her ön koşul için stopifnot deyimi varsaR'de işlev önkoşulları ve son durumları kontrol etmek ve belgelemek için deyimsel yol nedir?

ön şartları işaretleyerek, ben çalışma zamanı istisnası çeşit atma demek. Aynı durum, postconditions için de geçerlidir, ancak parametreler yerine dönüş değeriyle ilgilidir.

Ayrıca, bu ön koşulların ve son noktaların ne olduğunu belgelemenin standart bir yolu var mı? Örneğin, Java'da JavaDoc yorumlarında bunları açıklamak oldukça standarttır.

Bu konuda R'deki en iyi uygulamalar nelerdir?

cevap

2

belgelerinde açısından Sana roxygen2 paketine bir göz atın öneriyoruz. JavaDoc ve Doxygen ile karşılaştırılabilir, çünkü kaynak dosyadaki belgeleri kodla birlikte saklar. tanımlanması gerekir öğelerin, örneğin bir dizi vardır: girdi argümanlar nelerdir

  • işlev dönüş ne yapar

Ama bu kendi oluşturmanızı durmuyor pre ve öncesi ve sonrası koşulları belgeleyen post öğeler. roxygen2 hakkında daha fazla bilgi için bkz. CRAN veya StackOverflow.

2

?stopifnot

veya dostça hata iletileri ama daha ayrıntılı kod if (condition) stop("...message...") için

bakınız.