Kodomo

Пользователь

Учебная страница курса биоинформатики,
год поступления 2023

Указания по составлению и оформлению мини-обзора

[ Про геном и протеом бактерии ] [ Про биоинформатику как науку. Моя старая презентация ]

Структура научного текста, в том числе, мини-обзора про геном и протеом бактерии или археи

Структура относится к большинству научных текстов. То, что ниже, ориентировано прежде всего на биоинформатическую работу и мини-обзор.

Научный текст состоит из обязательных секций:

Дополнительные часто используемые секции:

Название отражает содержание текста.

Автор без комментариев.

Резюме предельно короткое описание предмета изучения и того, что изучалось. Читатель, прочитав резюме, должен понять, интересен ли ему текст.

Введение содержит информацию об объекте изучения со ссылками на литературные источники. В конце введения формулируются интересные вопросы и что исследуется в работе.

Материалы и методы — краткое указание источников данных, использованных в работе, достаточное для того, чтобы читатель мог эти данные найти сам, плюс описание методов, достаточное для воспроизведения результатов.

Для каждого результата из секции "Результаты" должно быть указано, каким методом он получен. В мини-обзорах вижу такие методы: из интернет источников (указать их), методом электронных таблиц, Google sheets, указать каким; внешним сервисом или программой, созданной не Автором, — указать сервис/программу; собственной программой — сослаться на строку в Сопроводительных материалах, в которой есть ссылка на код.

Материалы и методы служат для справки при чтении основного текста. Текст этой секции должен быть написан коротко и точно. В таком стиле: "Для ..... мы использовали ...."

Результаты разбиваются на разделы. Каждый раздел должен быть выделен в тексте, иметь понятное название и содержать один или несколько связанных между собой результатов.

Методы получения результатов в "Результатах" не описываются. Методам место в секции "Материалы и методы".

Результаты обычно подтверждаются сводными данными в таблицах и/или иллюстрируются на рисунках. Для этого в основном тексте ставится ссылка на таблицу или рисунок по номеру. Все таблицы и рисунки включаются в основной текст, лучше сразу после упоминания, если место позволяет. Другой вариант — поместить таблицы, рисунки и др. материалы в секцию Сопроводительные материалы. Особенно актуален это вариант для больших таблиц и рисунков, а также для описания и кодов собственных программ.

Заслуживающая внимания (новая) собственная программа также может быть отдельным результатом в секции "Результаты".

Таблицы оформляются так. Над таблицей пишут номер таблицы и её название. При необходимости за названием помещают пояснения. Внешний читатель должен понимать всё, что представлено в таблице. В первой строке таблицы — названия колонок. Как-то так: "Таблица 3. Число генов РНК, по категориям, закодированных в геноме".

Рисунки оформляются так. Под рисунком пишут номер рисунка и его название. При необходимости помещают пояснения. Внешний читатель должен понимать всё, что представлено на рисунке. Если график, то должно быть понятно, что по осям. Как-то так: "Рис. 3. Гистограмма длин белков, закодированных в геноме. Длина измеряется числом аминокислотных остатков".

Сопроводительные материалы содержат материалы, необходимые для понимания результатов, но не включённые в основной текст. В мини-обзоре это большие таблицы, составленные из внешних материалов, по представляющие читателю данные в более удобном виде. Например, таблицу с генами РНК (полученную из хромосомной таблица) отсортированную по категориям генов потом по длинам генов. Можно включать коды и описания программ и другие материалы.

Оформляются так. Каждый материал имеет номер (например S1, S2 и т.д.); название (например, "Таблица генов РНК"); короткое объяснение материала — если только названия недостаточно (например, "Программа получает на вход ... и выдаёт ..."); интернет ссылку на материал или адрес на kodomo, по которому можно найти и посмотреть материал.

Ссылаться в основном тексте обзора так: "см. таблицу S1 сопроводительных материалов".

Литература содержит пронумерованный список литературных источников или веб-адресов, оформленных стандартным образом. Для статей: авторы, название, журнал, том, страницы (или № выпуска), год; при наличии — веб-адрес доступа. Список литературы должен находиться в самом конце вашего обзора.

ТРЕБОВАНИЕ: на каждую таблицу, рисунок, сопроводительный материал, литературный источник должна быть ссылка в основном тексте.

Обсуждение может быть вынесено в отдельную секцию обзора, сразу после "Результатов", или же может присутствовать в секции "Результаты" после каждого результата, заслуживающего, по мнению автора, обсуждения. Это замечание касается и секции "Заключение". Если "Заключение" присутствует как отдельная секция, оно должно находиться до благодарностей, списка сопроводительных материалов и списка литературы.

Благодарности можно по желанию выразить всем, кто вам помогал, например: "Автор выражает благодарность своей сестре Ане за то, что она не шумела во время написания обзора". Если вам серьёзно помог (например, с методами) кто-то из сокурсников, то выразить ему персональную благодарность будет очень желательно (оценку за это не снизим!).

Как представить окончательную версию мини-обзора для проверки

Варианты

  1. В своей домашней директории на kodomo создайте поддиректорию mini_review в term1: term1/mini_review, положите в неё файл мини-обзора в формате .pdf. Укажите адрес этого документа на своей странице wiki.

  2. На свой Google-диск поместите файл (Upload → File) с мини-обзором в формате .pdf. Не забудьте сделать этот файл открытым на чтение для проверяющих (или для всех). Поставьте ссылку на него на своей странице wiki.

Как представить сопроводительные материалы для проверки

Один сопроводительный материал - это один файл и, в случае многостраничных файлов (Google Sheets например), название страницы в нем.

  1. В своей домашней директории на kodomo создайте поддиректорию: term1/mini_review/supplement. Положите в неё файлы с сопроводительными материалами. Укажите в мини-обзоре.pdf в разделе "Сопроводительные материалы" адрес этой директории. Для каждого сопроводительного материала идентификатором является имя файла и страница в нем (если надо).
  2. На своём Google-диске сохраните файлы с сопроводительными материалами. Для каждого сопроводительного материала в основном тексте укажите его название, страницу в файле (если нужно) и поставьте ссылку на нужную страницу.

2023/1/mini_review (последним исправлял пользователь sas 2023-12-01 12:39:18)