R:Оформление кода - История изменений

Артём Клевцов: /* Функция tidy.source() */

2014-04-16T04:37:16Z

‎Функция tidy.source()

Артём Клевцов: /* Функция tidy.source() */

2014-04-02T10:57:22Z

‎Функция tidy.source()

Артём Клевцов: /* Функция tidy.source() */

2014-04-02T10:54:23Z

‎Функция tidy.source()

Артём Клевцов в 10:53, 2 апреля 2014

2014-04-02T10:53:13Z

Артём Клевцов в 03:48, 20 февраля 2014

2014-02-20T03:48:38Z

Артём Клевцов в 14:22, 19 февраля 2014

2014-02-19T14:22:40Z

Артём Клевцов: /* Расстановка пробелов */

2014-02-19T14:20:53Z

‎Расстановка пробелов

Артём Клевцов: /* Расстановка пробелов */

2014-02-13T13:00:52Z

‎Расстановка пробелов

Артём Клевцов в 12:59, 13 февраля 2014

2014-02-13T12:59:04Z

Артём Клевцов: /* Присвоение */

2014-02-09T12:51:41Z

‎Присвоение

@@ Строка 89: / Строка 89: @@
 {{file
-   |subtitle=messy.R
+   |filename=messy.R
    |lang=r
    |code=

@@ Строка 117: / Строка 117: @@
 > library(formatR)
 > options(width = 80)
-> tidy.source(source = paste0(.libPaths()[1], "/formatR/format/messy.R"), replace.assign = TRUE)
+> tidy.source(source = paste0(.libPaths()[1], "/formatR/format/messy.R"))
 # a single line of comments is preserved
 + 1

@@ Строка 75: / Строка 75: @@
 == Функция <code>tidy.source()</code> ==
-Пакет {{r-package|formatR}} содержит функцию <code>tidy.source()</code>, которая позволяет отформатировать исходный код согласно заранее определённым правилам (аргументам). Функцию поддерживает ввод из буфера обмена (<code>source = "clipboard"</code>), файла (<code>source = "filename"</code>) или переменной (<code>source = varname</code>), являющейся вектором строк (character vector). Вывод результатов работы функции может перенаправлен в консоль (<code>output = TRUE</code>) или файл (<code>file = "filename"</code>).
+Пакет {{r-package|formatR}} содержит функцию <code>tidy.source()</code>, которая позволяет отформатировать исходный код согласно заранее определённым правилам (аргументам). Функция поддерживает ввод из буфера обмена (<code>source = "clipboard"</code>), файла (<code>source = "filename"</code>) или переменной (<code>source = varname</code>), являющейся вектором строк (character vector). Вывод результатов работы функции может быть перенаправлен в консоль (<code>output = TRUE</code>) или файл (<code>file = "filename"</code>).
 В качестве настроек форматирования можно указать:

@@ Строка 72: / Строка 72: @@
 {{r-code|code=<nowiki>plot(x,y, lwd = 4, col = green, main = "My Title")</nowiki>}}
 == Общая логика и порядок написания скриптов ==
@@ Строка 83: / Строка 149: @@
 === Ссылки ===
 * R Style. An Rchaeological Commentary - http://cran.r-project.org/web/packages/rockchalk/vignettes/Rstyle.pdf
 * Google's R Style Guide - http://google-styleguide.googlecode.com/svn/trunk/Rguide.xml

@@ Строка 11: / Строка 11: @@
 Прежде всего, названия файлов должны быть '''осмысленными''' и понятными.
-Общим требования к именованию файлов является написания расширений файлов, включающего принадлежность к языку программирования R с большой буквы. Обратим внимание, что все UNIX-like операционные системы чувствительны к регистру в названиях файлов. Например: {{Inline-code|pulse-analyse.R, report.Rmw, presentation.Rmd|lang="bash"}}. Бинарный формат хранения данных имеет расширение {{Inline-code|.RData|lang="bash"}}.
+Общим требования к именованию файлов является написания расширений файлов, включающего принадлежность к языку программирования R с большой буквы. Обратим внимание, что все UNIX-like операционные системы чувствительны к регистру в названиях файлов. Например: <code>pulse-analyse.R</code>, <code>report.Rmw</code>, <code>presentation.Rmd</code>. Бинарный формат хранения данных имеет расширение <code>.RData</code>.
 Имена файлов содержат символы в нижнем регистре.

@@ Строка 67: / Строка 67: @@
 Рекомендуется отделять пробелами оператор присвоения значений аргументов:
-{{r-code|code=<nowiki>plot(x,y, lwd=4, col=green, main="My Title")}}
+{{r-code|code=<nowiki>plot(x,y, lwd=4, col=green, main="My Title")</nowiki>}}
 Более корректно:
-{{r-code|code=<nowiki>plot(x,y, lwd = 4, col = green, main = "My Title")}}
+{{r-code|code=<nowiki>plot(x,y, lwd = 4, col = green, main = "My Title")</nowiki>}}
 == Общая логика и порядок написания скриптов ==

@@ Строка 59: / Строка 59: @@
 Пробелы также '''не''' ставятся между круглыми скобками:
-<syntaxhighlight lang="rsplus">
+{{r-code|code=<nowiki>if ( (x == 1) & (y == 2) )</nowiki>}}
 if ( (x == 1) & (y == 2) )
-</syntaxhighlight>
 Более корректно:
-<syntaxhighlight lang="rsplus">
+{{r-code|code=<nowiki>if ((x == 1) & (y == 2))</nowiki>}}
 if ((x == 1) & (y == 2))
-</syntaxhighlight>
 Рекомендуется отделять пробелами оператор присвоения значений аргументов:
-<syntaxhighlight lang="rsplus">
+{{r-code|code=<nowiki>plot(x,y, lwd=4, col=green, main="My Title")}}
 plot(x,y, lwd=4, col=green, main="My Title")
-</syntaxhighlight>
 Более корректно:
-<syntaxhighlight lang="rsplus">
+{{r-code|code=<nowiki>plot(x,y, lwd = 4, col = green, main = "My Title")}}
 plot(x,y, lwd = 4, col = green, main = "My Title")
-</syntaxhighlight>
 == Общая логика и порядок написания скриптов ==

@@ Строка 46: / Строка 46: @@
 Пробелы ставятся '''до''' и '''после''' математических символов и бинарных или логических операторов:
-* математические символы: «=», «+», «-», «*», «/»;
+* математические символы: <tt>«=», «+», «-», «*», «/»</tt>;
-* операторы присвоения: «<-», «->»
+* операторы присвоения: <tt>«<-», «->»</tt>;
-* бинарные операторы: «%in%», «%%», «%/%»;
+* бинарные операторы: <tt>«%in%», «%%», «%/%»</tt>;
-* логические операторы: «==», «!=», «&», «|», «<», «>», «<=», «>=».
+* логические операторы: <tt>«==», «!=», «&», «|», «<», «>», «<=», «>=»</tt>.
 Пробелы также ставятся '''после''' запятых.
-Пробелы ставятся '''перед''' открывающейся фигурной скобкой - «{».
+Пробелы ставятся '''перед''' открывающейся фигурной скобкой - <tt>«{»</tt>.
-Пробелы ставятся '''перед''' открывающейся круглой скобкой - «(», за исключением объявления или вызова функции.
+Пробелы ставятся '''перед''' открывающейся круглой скобкой - <tt>«(»</tt>, за исключением объявления или вызова функции.
 Пробелы также '''не''' ставятся между круглыми скобками:

@@ Строка 21: / Строка 21: @@
 Существуют различные подходы к именованию функций и переменных. Но все они содержат общие рекомендации:
-* Названия должны быть понятны и осмысленны: {{Inline-code|colMeans|lang="rsplus"}}, {{Inline-code|read.table|lang="rsplus"}};
+* Названия должны быть понятны и осмысленны: <code>colMeans</code>, <code>read.table</code>;
 * Названия не должны быть слишком длинными или слишком короткими, что могли бы затруднить их понимание или восприятие;
-* Не использовать имена уже используются в R или популярных пакетах. Для проверки уже используемых имён можно использовать функции {{Inline-code|find()|lang="rsplus"}} и {{Inline-code|apropos()|lang="rsplus"}};
+* Не использовать имена уже используются в R или популярных пакетах. Для проверки уже используемых имён можно использовать функции <code>find()</code> и <code>apropos()</code>;
 Можно выделить несколько подходов к именованию функций и переменных:
-* alllowercase (слитное написание, все символы в нижнем регистре, без разделителей). Широко используется в MATLAB. Примеры: {{Inline-code|searchpaths|lang="rsplus"}}, {{Inline-code|searchpaths|lang="rsplus"}};
+* alllowercase (слитное написание, все символы в нижнем регистре, без разделителей). Широко используется в MATLAB. Примеры: <code>searchpaths</code>, <code>searchpaths</code>;
-* period.separated (все символы в нижнем регистре с разделителями в виде точек). Используется только в R. Примеры: {{Inline-code|as.numeric|lang="rsplus"}}, {{Inline-code|read.table|lang="rsplus"}}, {{Inline-code|data.frame|lang="rsplus"}};
+* period.separated (все символы в нижнем регистре с разделителями в виде точек). Используется только в R. Примеры: <code>as.numeric</code>, <code>read.table</code>, <code>data.frame</code>;
-* underscore_separated (все символы в нижнем регистре с разделителями в виде нижних подчёркиваний). Используется дл именования переменных и функций в C++, Perl, Ruby. Примеры: {{Inline-code|package_version|lang="rsplus"}}, {{Inline-code|seq_along|lang="rsplus"}};
+* underscore_separated (все символы в нижнем регистре с разделителями в виде нижних подчёркиваний). Используется дл именования переменных и функций в C++, Perl, Ruby. Примеры: <code>package_version</code>, <code>seq_along</code>;
-* lowerCamelCase (слитное написание, первый символ в нижнем регистре, начало каждого составного слова в верхнем регистре). Используется во многих языках программирования. Примеры: {{Inline-code|colMeans|lang="rsplus"}}, {{Inline-code|suppressPackageStartupMessage.|lang="rsplus"}};
+* lowerCamelCase (слитное написание, первый символ в нижнем регистре, начало каждого составного слова в верхнем регистре). Используется во многих языках программирования. Примеры: <code>colMeans</code>, <code>suppressPackageStartupMessage.</code>;
-* UpperCamelCase (слитное написание, первый символ в верхнем регистре, начало каждого составного слова в верхнем регистре). Используется во многих языках программирования. Примеры: {{Inline-code|Vectorize|lang="rsplus"}}, {{Inline-code|NextMethod|lang="rsplus"}};
+* UpperCamelCase (слитное написание, первый символ в верхнем регистре, начало каждого составного слова в верхнем регистре). Используется во многих языках программирования. Примеры: <code>Vectorize</code>, <code>NextMethod</code>;
 В различных руководствах приводятся разные рекомендации. Как мы уже отмечали, гораздо более важно придерживаться единого стиля при написании кода. В исходном коде R преимущественно используются стили lowerCamelCase, period.separated и underscore_separated. При этом period.separated, как уже отмечалось выше, используется в основном для создания функций для обработки S3 классов.
@@ Строка 86: / Строка 86: @@
 # Комментарий, содержащий информацию об авторе;
 # Комментарий, содержащий информацию о содержании и назначении скрипта;
-# Импорт пакетов и скриптов - вызов {{Inline-code|library()|lang="rsplus"}} и {{Inline-code|source()|lang="rsplus"}};
+# Импорт пакетов и скриптов - вызов <code>library()</code> и <code>source()</code>;
 # Объявления функций:
 # Выполнение основный выражений.

@@ Строка 37: / Строка 37: @@
 == Присвоение ==
-Для присвоения используется «<-» или «->», но не «=», который используется только для указания значения аргументов функций.
+Для присвоения используется «<-» или «->», но не «=», который используется только для указания значений аргументов функций.
 == Отступы ==