Правила оформления кода методов

  • Все методы размещаются в соответствующем пространстве имен.
  • Имя метода соответствует имени страницы в wiki.
  • Метод принимает аргумент троеточие.
  • Первый аргумент - набор данный (data.frame).
  • Тест имеет тоже имя, что и функция с постфиксом .test (доступны модули библиотеки testthat).
  • Список аргументов имеет тоже имя, что и функция с постфиксом .args .

Пространство имен: recalc

Дополнительные параметры: count - количество элемента на который выполняется нормировка.

Возвращаемое значение: data.frame с _pfu .

Пространство имен: interpmin

Дополнительные параметры: нет

Возвращаемое значение: data.frame произвольного содержания. Если содержит поле строковое Formula, то оно будет отображено в виде формулы с индексами (символ _ используется).

Пространство имен: classifydiag

Дополнительные параметры: annotate - выводить текстовые надписи на диаграмме, labels - выводить имена точек.

Возвращаемое значение: ggplot совместимый объект.

Пространство имен: sensors.p sensors.t

Дополнительные параметры: usePFU - выполнять пересчет самостоятельно или ожидать предрассчитанных значений _wtp.

Метод args: возвращает список из args$minerals - списка минералов для метода, args$ranges - списка диапазонов.

Возвращаемое значение: data.frame со столбцами Name, имя диапазона, значение.

  • code_guide.txt
  • Последние изменения: 2018/11/12 15:07
  • (внешнее изменение)