Как мне создать индекс контента для кода в R

Question

Для моей работы мне нужно написать сценарии длиной более 600 строк. Важно, чтобы мои сценарии были удобочитаемыми для моих коллег, но я заметил, что даже при чтении собственного кода мне нужно много прокручивать, чтобы найти определенную функцию.

Проблема не столько в том, что код уродливили без комментариев - в каждой строке есть комментарий, объясняющий, что делается и почему. Это также организовано - оно следует очень предсказуемой структуре. С чем я борюсь, так это с вертикальной прокруткой. Кажется устаревшим. Когда я пишу слово или латексный документ, я могу создавать заголовки, которые распознаются программой как индексные точки. Эти индексные точки затем отображаются в оглавлении.

Могу ли я сделать что-то подобное в R? Есть ли какой-нибудь язык программирования, позволяющий индексировать такие точки? Википедия тоже это делает, например, ссылка https://en.wikipedia.org/wiki/Meteorological_history_of_Hurricane_Patricia#Peak_strength приведет вас к параграфу о пиковой силе урагана.

Answer 1

если вы используете RStudio, вы можете сделать это следующим образом. Вам нужно использовать комментарии, подобные этим, и показать схему документа (рядом с источником)

#library----

#some code---- 


#example----

Answer 2

Мой очень личный трюк заключается в следующем. Я организую порции кода в блоки if (TRUE), чтобы их можно было сложить, например, в RStudio.

# Step 1 of the pipeline
if(TRUE){
    message("Step 1 starting")
    Sys.sleep(0.1)
    i<-5
    i<-i+5
}

# Step 2 of the pipeline
if(TRUE){
    message("Step 2 of the pipeline")
    i<-i^2
    message("The results is ",i)
}

, чтобы в конце он выглядел более аккуратно: