Методические рекомендации к выполнению практических заданий и лабораторных работ, а также оформлению отчетов по ним
Общие требования
- Результаты практических и лабораторных работ выполняются в электронном виде с с использованием сервиса Github.
- Репозиторий должен быть публично доступным.
- Конечный результат, который представляется на проверку должен находиться на ветке
main
илиmaster
Структура
- Структура репозитория представлена здесь
- Отчет оформляется с использованием языка разметки Rmarkdown или в нотации издательской системы Quarto
- Сам отчет должен находиться в папке лабораторной или практической работы и называться
README.md
- Вместе с отчетом должен присутствовать исходный ноутбук (в виде файлов
Rmd
(Rmarkdown) илиqmd
(Quarto)), из которого был сгенерирован отчет. - Если для выполнения работы требуется использование языков программирования, то весь представленный Вами код (в чанках кода) должен выполняться в ходе рендеринга Вашего отчета – Ваша работа должна быть воспроизводимой!
- Результат работы Вашего кода должен быть автоматически вставлен в сгенерированный отчет
Содержание
- Каждый шаг Вашей работы должен быть описан и обоснован целью работы
- При решении задач предпочтение должно отдаваться современным средствам и методам, а также тем методам, которые рассматривались в ходе изучения курса. Необоснованное использование старых сторонних библиотек и программных пакетов крайне НЕ РЕКОМЕНДУЕТСЯ, как и случайных ответов с сайтов типа StackOverflow и т.д.
Tip
Если Вы идете #в-ногу-со-временем-и-даже-over-the-edge, лучше использовать формат Quarto
Хорошо структурированный и оформленный отчет подчеркивает уровень выполненной работы, глубину детальной проработки темы Автором и свободу владения и инструментами и материалом!
Обратите внимание!
В markdown:
- может быть только 1 заголовок первого уровня (символ
#
) - Каждый элемент отделяется от другого, как минимум, 1 пустой строкой
# Один единственный заголовок первого уровня
## Заголовок 1
Текст 1
Текст 1
Текст 1
## Заголовок 2
Текст 2
Текст 2 Текст 2
- программный код выделяется одним или тремя апострофами “`” (часто, клавиша ё в английской раскладке) – пример на Github