Код R (knitr)

Overleaf має інтеграцію з knitr, яка дає змогу додавати код R до документа LaTeX для створення динамічного виводу.

Документи, що містять код R, потрібно зберігати з розширенням .Rtex або .Rnw, інакше код не працюватиме. Розгляньмо приклад:

\documentclass{article}
\begin{document}

You can type R commands in your \LaTeX{} document which will be processed and their output included in the document:

<<>>=
# Create a sequence of numbers
X = 2:10

# Display basic statistical measures
summary(X)

@
\end{document}

Відкрити цей приклад knitr в Overleaf

Як бачите, текст між символами <<>>= і @ — це код R. Цей код і його вивід друкуються у форматі, подібному до лістингу. Цей фрагмент коду може приймати додаткові параметри для налаштування динамічного виводу, як описано в наступному розділі.

​

Фрагменти коду

Блок коду, подібний до наведеного в попередньому розділі, зазвичай називають фрагментом (chunk). Для фрагментів knitr можна задавати додаткові параметри. Див. приклад нижче:

\documentclass{article}
\begin{document}

You can type R commands in your \LaTeX{} document which will be processed and their output included in the document:

<<echo=FALSE, cache=TRUE>>=
# Create a sequence of numbers
X = 2:10

# Display basic statistical measures
summary(X)

@
\end{document}

Відкрити цей приклад knitr в Overleaf

Між << і >> передано два додаткові параметри.

• echo=FALSE Приховує код і друкує лише вивід, згенерований R.

• cache=TRUE Якщо cache має значення true, фрагмент не виконується повторно — використовуються лише згенеровані ним об’єкти. Це заощаджує час, якщо дані в цьому фрагменті не змінилися.

  Зауважте, що параметр cache=TRUE наразі не підтримується в Overleaf, але має працювати локально.

Інші параметри див. у довідковому посібнику.

​

Вбудовані команди

Можна звертатися до об’єктів, згенерованих у фрагменті, і друкувати їх безпосередньо в тексті.

\documentclass{article}
\begin{document}

You can type R commands in your \LaTeX{} document which will be processed and their output included in the document:

<<echo=FALSE, cache=TRUE>>=
# Create a sequence of numbers
X = 2:10

# Display basic statistical measures
summary(X)

@

So, the mean of the data is $\Sexpr{mean(X)}$
\end{document}

Відкрити цей приклад knitr в Overleaf

Команда \Sexpr{mean(X)} друкує результат, повернутий кодом R mean(X). Усередині фігурних дужок можна передати будь-яку команду R.

​

Графіки

До документа knitr також можна додавати графіки, як у цьому прикладі:

\documentclass{article}
\begin{document}

<<plot1, fig.pos="t", fig.height=4, fig.width=4, fig.cap="First plot">>=

xdata = read.csv(file="data.txt", head=TRUE,sep=" ")

hist(xdata$data, main="Overleaf histogram", xlab="Data")

@

The figure \ref{fig:plot1} is simple histogram.

\end{document}

Відкрити цей приклад knitr в Overleaf

Ця гістограма використовує дані з файлу “data.txt”, збереженого в поточному робочому каталозі. Фрагменту передано кілька параметрів, пов’язаних із рисунком.

plot1 Мітка, яка використовується для посилання на графік. Префікс “fig:” обов’язковий. У прикладі видно, що на рисунок посилаються через \ref{fig:plot1}. fig.pos="t" Параметр розташування. Такий самий, як і в середовищі figure. fig.height=4, fig.width=4 Ширина та висота рисунка. fig.cap="First plot" Підпис до рисунка.

​

Зовнішні скрипти R

До документа knitr можна імпортувати частини зовнішнього скрипта R. Це дуже зручно, оскільки скрипт часто пишуть і налагоджують у зовнішній програмі, перш ніж включити його в документ.

Припустімо, що у файлі mycode.R є такий код R, який ми включаємо в наш документ LaTeX:

## ---- myrcode1
# Create a sequence of numbers
 X = 2:10

## ---- myrcode2
# Display basic statistical measures
summary(X)

Зверніть увагу на рядки:

## ---- myrcode1

і

## ---- myrcode2

Вони позначають початок фрагмента коду й обов’язкові, якщо ви хочете використати цей скрипт у документі, як показано в наступному фрагменті коду:

The chunk below will not be printed

<<echo=FALSE, cache=FALSE>>=
read_chunk("mycode.R")
@

The code must show up here

<<myrcode2>>=

@

Перший фрагмент не друкується й використовується лише для імпорту скрипта командою read_chunk("mycode.R"). Саме тому встановлено параметр echo=FALSE. Крім того, скрипти не повинні кешуватися. Після імпорту скрипта можна надрукувати фрагмент, використовуючи мітку, задану після ## ----. У цьому випадку це myrcode2.

Ми зібрали всі фрагменти коду зі статті в проєкт, який можна відкрити в Overleaf.

​

Довідковий посібник

Деякі параметри фрагментів:

• results. Змінює поведінку результатів, згенерованих кодом R. Можливі значення:
  • markup Форматувати вивід за допомогою LaTeX.
  • asis Друкувати необроблені результати з R.
  • hold Утримувати результати виводу й виводити їх наприкінці фрагмента.
  • hide Приховати результати.
• echo. Чи включати вихідний код R. Інші варіанти:
  • echo=2:3 друкує лише другий і третій рядки;
  • echo=-2:-3 виключає лише другий і третій рядки.
• cache. Чи кешувати фрагмент коду. Можливі значення: TRUE і FALSE
• highlight. Чи підсвічувати вихідний код. Можливі значення: TRUE і FALSE
• background. Колір фону фрагмента. Можна використовувати формати rgb та HTML. Значення за замовчуванням — “#F7F7F7”.