Включение кода в финансы Диссертация

Я пишу диссертацию, и у меня есть вопрос, как представить свои результаты.

Поэтому я использовал Rstudio для написания кода, с помощью которого я провел некоторый статистический анализ, используя некоторые тесты. Я включил все результаты тестов в таблицу, которую добавил в свою диссертацию.

Теперь я не уверен, нужно ли мне добавлять код, который я использовал, и нужно ли мне объяснять, как его использовать. Я не знаю, так как моя диссертация не посвящена коду, и я мог бы сделать это с помощью SPSS. На самом деле я не ограничен методом выполнения тестов, поэтому я не знаю, насколько мне следует сосредоточиться на самом коде. Так что да, Rstudio — это просто инструмент, а не требование.

Заранее спасибо!

Если код не был в центре внимания, вы всегда можете включить его в приложение.
Похоже, это вопрос к вашему консультанту.
Я пытаюсь провести его, но он не отвечает быстро, у меня есть крайний срок, и другой человек, который консультирует меня, тоже не уверен
Как вы думаете, я должен объяснять код, или достаточно просто добавить комментарии?

Ответы (3)

Насколько подробно, если таковые имеются, объяснения кода, которые вы включаете в свою диссертацию, — это вопрос, на который лучше всего ответит ваш консультант.

Однако для воспроизводимости крайне важно, чтобы в случае проведения численного моделирования был доступен исходный код, используемый для него. Благодаря Интернету и таким сайтам, как github, bitbucket и т. д., очень просто поделиться кодом и дать другим возможность воспроизвести численные эксперименты и симуляции.

Если численные методы сами по себе не являются предметом исследования, т. е. вы просто использовали какие-то стандартные методы в R для какого-то анализа, одна строка, похожая на «статистический анализ был выполнен в R с использованием кода, найденного на <insert your github>». Или, если кода немного, его можно вставить прямо в приложение.

Независимо от того, где используется общий код, важно отметить, какие версии/пакеты/зависимости также использовались. В идеале код должен быть четким и хорошо задокументированным, но можно потратить чрезмерное количество времени на «объяснение того, как его использовать». Если возможно, также сохраните в репозитории или свяжите любые используемые наборы данных.

Только сказать что-то вроде «статистический анализ был выполнен в R» или «для решения уравнений использовался специальный неявно-явный численный метод» действительно ужасно для воспроизводимости и должно считаться дурным тоном. В качестве аналогии возьмем начало экспериментального раздела недавней статьи по химии. ( Этот к вашему сведению)

Все коммерчески доступные реагенты и растворители, используемые в этом исследовании, были приобретены у TCI, Fisher или Sigma-Aldrich и использовались без дополнительной очистки. Колоночную флэш-хроматографию выполняли с использованием силикагеля 40-63 мкм (SiliaFlash F60 от Silicycle). Препаративную тонкослойную хроматографию проводили на пластинах с силикагелем 60 Å F254 (20×20 см, 1000 мкм, SiliaPlate от Silicycle) и визуализировали в УФ-свете (254/360 нм).

Плохие примеры численной воспроизводимости были бы похожи на то, что вместо всего того подробного объяснения материалов и методов авторы только что сказали: «Мы использовали купленные в магазине продукты, использовали хроматографию с силикагелем и рассмотрели это при свете».

Если есть возможность, включите.

Как я понял из вашего вопроса, написан новый код, который не был доступен вам из другого места (например, в виде пакета из CRAN ), который вы можете указать по адресу и используемой версии, и это был один из ваших основных инструментов для обрабатывать данные. Включение вашего кода, написанного в вашу диссертацию, позволяет членам жюри тезисов воспроизвести то, что вы сделали (возможно, некоторые вообще не поймут код, другим может быть очень интересно проверить примененные методологии). Некоторые из печатных тезисов, которые я видел, включали как краткие комментарии к коду (например, через списки пакетов использования LaTeX,, в равной степени поддерживающий R), а также соответствующий код, скопированный на компакт-диск; сегодня электронные репозитории университетов и их библиотек могут принимать как версию вашей диссертации в формате .pdf, так и этот дополнительный материал (исполняемый код и данные в архиве .zip).

Обмен используемыми вами инструментами с будущими членами вашей группы позволяет им продолжать работу по направлению исследований, включать ваши методики в другие программы. Это может привести к публикациям с вами в качестве соавтора. В равной степени (если это еще не часть SI ваших исследовательских публикаций), это значительно облегчает копирование работы, которую вы внесли другими, также известными как воспроизводимые исследования (например, см. первую часть этой презентации ), и является частью принципов FAIR . . (Поскольку вы выбрали программный подход, некоторые проблемы с электронными таблицами [ неполный список ] уже устранены.)

По согласованию с вашим руководителем/вашим университетом вы можете рассмотреть возможность публикации своего кода на таких платформах, как CRAN ( пример ), GitHub ( пример поиска финансов и R ) с некоторыми дополнительными усилиями. Как метод, он может подойти для отдельной статьи неспециализированного сайта, такого как JOSS ( пример ), или статьи, посвященной вашей специальности.

Основываясь на моем опыте, вы можете создать отчет с цифрами, встроенными в вашу диссертацию, используя r Markdown, и вы можете разместить свой код и исходные файлы на GitHub. Для паба вы можете добавить эту информацию в дополнительный файл. Обязательно получите одобрение от вашего PI , прежде чем публиковать информацию на GitHub. :)