Summary  
Comments are non-executable annotations introduced with the `#` symbol that the interpreter ignores, used to explain code logic or temporarily disable lines during debugging.

General domain of usage  
Code documentation

**コメント**は、コード内に記述される実行されないメモ。

定義

コードの目的の説明、文脈の提供、デバッグ時の一時的な行の無効化などに使用。

## コメントの作成
コメントを追加するには、`#` 記号を使用。`#` 以降の同じ行の内容はRによって無視される。

# A standalone comment
11 + 3  # Adding eleven and three

この例では、コンソールには `11 + 3` の結果のみが表示され、コメントは無視されます。

## ベストプラクティス
- 複雑なコード部分の説明にコメントを使用;
- コメントの過剰な記述はスクリプトを煩雑にするため避ける;
- デバッグ時に一時的に行を無効化するためにコメントを活用。

# =====================================================================
# СКРЫТЫЕ ТЕСТЫ ДЛЯ user_code.R
#
# КАК МЫ РАБОТАЕМ:
#  1) Один раз выполняем пользовательский файл в отдельном окружении
#     через run_user_code(...). Получаем:
#       - res$values$...  — переменные из окружения (prices, items и т.п.)
#       - res$logs        — весь печатный вывод (включая результаты выражений)
#  2) Каждый кейс — отдельный dynamic_test(...), то есть отдельная строка
#     в отчёте, с «говорящим» названием (успех/ошибка).
# =====================================================================

library(testthat)
source(testthat::test_path("helper-run_user_code.R"), local = TRUE)

# Ищем user_code.R в двух вариантах:
#  1) в корне проекта:        ../../user_code.R  (относительно tests/testthat)
#  2) рядом с тестами:        user_code.R        (внутри tests/testthat)
candidates <- c(
  testthat::test_path("..", "..", "user_code.R"),
  testthat::test_path("user_code.R")
)

# Нормализуем пути, оставляем существующие
candidates_norm <- vapply(candidates, function(p) {
  tryCatch(normalizePath(p, winslash = "/", mustWork = FALSE), error = function(e) NA_character_)
}, character(1))

exists_flags <- file.exists(candidates_norm)
if (!any(exists_flags)) {
  stop(
    sprintf(
      "user_code.R not found.\nChecked paths:\n  - %s\nWorking dir: %s",
      paste(candidates, collapse = "\n  - "),
      getwd()
    )
  )
}

user_file <- candidates_norm[which(exists_flags)[1]]  # первый найденный

# Выполняем user_code.R один раз, извлекаем переменные и перехватываем вывод
res <- run_user_code(
  file       = user_file,
  capture    = c("prices", "items"),
  echo       = FALSE,
  print.eval = TRUE
)

{
  out <- trimws(paste(res$logs, collapse = " "))
  ok  <- grepl("([^0-9]|$)7.142857([^0-9]|$)", out)

  dynamic_test(
    ok,
    "Lines commented successfully",
    sprintf("Lines are not commented", out)
  )
}

test_hidden.R

# =====================================================================
# ВСПОМОГАТЕЛЬНЫЕ ХЕЛПЕРЫ ДЛЯ ТЕСТОВ
#
# Файл называется helper-*.R: testthat автоматически подхватывает такие
# файлы перед выполнением любых тестов в каталоге tests/testthat.
# =====================================================================

# -----------------------------------------------------------------------------
# run_user_code(...)
#  - безопасно запускает user_code.R в отдельном окружении (env)
#  - перехватывает ВЕСЬ вывод (stdout): как результаты выражений, так и print()/cat()
#  - возвращает:
#       values  — список запрошенных переменных (по именам из аргумента capture)
#       logs    — вектор строк перехваченного вывода
#       env     — окружение, где выполнялся user_code (можно исследовать при необходимости)
#
# ПАРАМЕТРЫ:
#   file        — путь к user_code.R
#   capture     — character-вектор имён переменных, которые нужно извлечь после выполнения
#   inject      — список объектов/функций, которые нужно «подложить» в среду исполнения
#                 (можно использовать для моков/маскировки опасных функций: system, file.remove и т.д.)
#   echo        — печатать код при исполнении (обычно FALSE)
#   print.eval  — ПЕЧАТАТЬ РЕЗУЛЬТАТЫ ВЫРАЖЕНИЙ. Ключевая опция, чтобы строки вида
#                 `prices['Armchair']` попадали в stdout без явного print().
#
# БЕЗОПАСНОСТЬ:
#   - В базовом R нет полноценной «песочницы». Мы изолируем код в новом env,
#     но ОС-доступ не блокируется магически.
#   - Для задач онлайн-платформы можно частично «глушить» опасные вызовы через inject,
#     например:
#       inject = list(
#         system      = function(...) stop("system disabled"),
#         file.remove = function(...) stop("file.remove disabled")
#       )
# -----------------------------------------------------------------------------
run_user_code <- function(
  file = "user_code.R",
  capture = character(0),
  inject = list(),
  echo = FALSE,
  print.eval = TRUE
) {
  # Бросаем явную ошибку, если файла нет (проще диагностировать)
  stopifnot(file.exists(file))

  # Изолированное окружение: parent=baseenv() (без лишних пользовательских объектов сверху)
  env <- new.env(parent = baseenv())

  # Подмешиваем моки/данные в окружение (при необходимости)
  if (length(inject)) list2env(inject, envir = env)

  # ВАЖНО: перехватываем весь вывод выполнения файла.
  # source(..., local=env, echo, print.eval) исполняет код ВНУТРИ env.
  # print.eval=TRUE заставляет R печатать результаты выражений (как в консоли),
  # что позволяет проверять «голые» выражения без print().
  logs <- utils::capture.output(
    base::source(file, local = env, echo = echo, print.eval = print.eval)
  )

  # Собираем запрошенные значения переменных
  values <- setNames(vector("list", length(capture)), capture)
  for (nm in capture) {
    if (exists(nm, envir = env, inherits = FALSE)) {
      values[[nm]] <- get(nm, envir = env, inherits = FALSE)
    } else {
      values[[nm]] <- NULL
    }
  }

  list(values = values, logs = logs, env = env)
}

# -----------------------------------------------------------------------------
# dynamic_test(condition, success, failure)
#  - Создаёт ОДИН тест с «динамическим» названием.
#  - Если condition=TRUE → тест называется success.
#  - Если condition=FALSE → тест называется failure, и тест проваливается.
#  - Используем настоящую expectation (expect_true(TRUE)), чтобы репортёры всегда
#    печатали имя успеха (TAP, progress и т.д.).
# -----------------------------------------------------------------------------
dynamic_test <- function(condition, success, failure) {
  if (isTRUE(condition)) {
    testthat::test_that(success, {
      testthat::expect_true(TRUE)
    })
  } else {
    testthat::test_that(failure, {
      testthat::fail(failure)
    })
  }
}
# =====================================================================

helper-run_user_code.R

データ分析で最も広く使用されている言語の一つであるRについて、確かな理解を身につけます。基本的なデータ型や一次元の値を学び、次に行列、データフレーム、リストなどの多次元構造へと進みます。統計解析やデータ駆動型の意思決定にRを効果的に活用するためのスキルを習得します。

算術演算、変数、出力関数、コメントなど、Rの構文の基本を学びます。演習を通じて計算論理の理解を深めます。

Rのデータ型を探求し、データ処理におけるその役割を理解します。情報の整理と分析に不可欠な構造としてベクトルを扱うスキルを身につけます。

カテゴリカルデータを効果的に管理する能力を身につけます。生データを明確なカテゴリに変換することで、値を構造化し、グループ化し、解釈する方法を学びます。

構造化された二次元データを表現し、操作する方法を理解します。分析作業のために、行列の変換、ラベリング、演算の適用に自信を持てるようになります。

Rで最も広く使用されている表形式データ構造を習得します。データセットを整理し、変換し、洞察を抽出して、データ駆動型の意思決定を支援します。

リストがベクトルを超えて、異なる型や長さの要素を格納できることを学びます。複雑なデータ構造を整理するために、リストの作成、アクセス、変更の能力を身につけます。

コメント

コメントの作成

例

ベストプラクティス

解答