introduction: termine la 1re version du document

- Ajoute les captures d'écran nécessaires.
- Apporte les modifications au style pour la conversion.
- Met à jour les références bibliographiques.
- Finalise le contenu de l'introduction.
- Documente la génération du PDF dans le `README.md`.
- Documente le déroulé de la présentation.

Co-Authored-by: iGor milhit <igor@milhit.ch>
main v0.1.0
iGor milhit 2023-04-25 16:53:48 +02:00 committed by iGor milhit
parent 5c9215f1cd
commit 2c50be353c
Signed by: igor
GPG Key ID: 5785C84B21C88AE6
16 changed files with 401 additions and 51 deletions

View File

@ -11,8 +11,55 @@ Ce répertoire contient le matériel utilisé pour les [deux «rendez-vous de
l'info scientifique» sur Markdown][rdv] proposés par la bibliothèque de l'info scientifique» sur Markdown][rdv] proposés par la bibliothèque de
l'Université de Genève: l'Université de Genève:
- [L'introduction à la prise de notes][intro] - [L'introduction à la prise de notes][intro].
- [Aller plus loin avec Markdown][avancé].
## Pré-requis
- `pandoc`.
- `pagedjs-cli` (`npm install -g puppeteer pagedjs pagedjs-cli`).
## Génération du PDF
Lancer les commandes depuis le répertoire contenant le fichier source au format
Markdown, soit `./intro`, soit `./avancé`.
Pour générer le fichier HTML à servir par un serveur web pour le visualiser
dans le navigateur, il faut utiliser `pandoc` avec les paramètres suivants (à
adapter au fichier à générer):
```bash
pandoc --standalone --to=html \
--template=../template.html --css=../style.css \
--toc --toc-depth=2 --citeproc \
--output=intro.html intro.md
```
- `--standalone` pour obtenir tous les scritps javascript et les styles CSS
nécessaires à l'interface de visualisation et à la mise en forme voulue dans
le fichier HTML.
- `--to=html` pour convertir vers du HTML.
- `--template=` et `--css=` indiquent quels modèle et feuille de style
utiliser.
- `--toc` et `--toc-depth=2` générent la table des matière en n'allant pas plus
loin que les titres de niveau 2.
- `--citeproc` indique qu'il faut tenir compte des citations et générer la
bibliographie.
- `--output=` précise où et à quel nom générer le fichier de sortie.
Pour générer directement le PDF:
```bash
pandoc --standalone --citeproc \
--to=pdf --pdf-engine=pagedjs-cli \
--css=../style.css --toc --toc-depth=2 \
--output=intro.pdf intro.md
```
La différence ici est le format de destination (PDF) et le fait d'utiliser
`pagedjs-cli` comme outil de composition du PDF.
[projet]: ./ [projet]: ./
[rdv]: https://www.unige.ch/biblio/index.php?cID=4127 "Présentation des 2 rendez-vous sur le site de la bibliothèque de l'Université de Genève" [rdv]: https://www.unige.ch/biblio/index.php?cID=4127 "Présentation des 2 rendez-vous sur le site de la bibliothèque de l'Université de Genève"
[intro]: ./intro.md [intro]: ./intro/intro.md
[avancé]: ./avancé/avancé.md

View File

@ -0,0 +1,64 @@
---
title: Déroulé de l'introduction à markdown
date: 2023-04-26T09:01:56+02:00
id: 20230426090205
tags: [rdv-info, déroulé, markdown]
---
## Présentation (2 min.)
- Présentation.
- Partage du PDF.
- Mention des questions à la fin.
## Objectifs (1 min.)
- Avantages des fichiers au format texte et de markdown pour la prise de notes.
- Syntaxe de base.
- Présentation d'éditeurs.
- Aperçu des possibilités avancées.
## Présentation
- Ouvrir HackMD.
- Montrer que ce n'est que du texte = format texte.
- Montrer le rendu et la structure.
- Avantages du format texte :
- Fichiers simples et légers.
- Ne dépendant ni d'un logiciel particulier.
- Pérennité.
- Portabilité.
- Sauvegarde, synchronisation, partage.
- Recherche textuelle facilitée.
- Favorise un riche écosystème pour utiliser ou manipuler les fichiers.
- Conclusion :
- Rapidité et légèreté adaptée à la prise de note.
- Notes structurées, recherche textuelle efficace.
- Adapté pour documents simples (notes) ET pour documents complexes (thèse).
- Constitution d'une base de connaissance.
- Détail de la syntaxe depuis HackMD.
- Importance d'apprendre et d'utiliser régulièrement.
- Titres.
- Paragraphes.
- Italiques et gras.
- Liens. Sans et avec référence.
- Image.
- Éditeurs :
- Dédiés (typora, abricotine).
- Bases de connaissance (obsidian).
- Académique (Zettlr), intégration facilitée de Zotero.
- Généralistes (visual studio code). Si vous en utiliser déjà un. Si vous
avez un usage avancé.
- Fonctionnalités nécessaires :
- Prévisualisation.
- Autocomplétion de la syntaxe.
- Navigateur de fichiers.
- Un plus :
- Correcteur orthographique.
- Formatage automatique des tableaux.
- Suivi des liens internes, entre fichiers.
- Usages avancés :
- Démo avec Visual Code.
- Ouvrir README, suivre le lien.
- Chercher le fichier rdv-info-déroulé.
- Chercher la chaîne `rdv-info`.

View File

@ -7,20 +7,18 @@ creation_date: 2023-04-19T11:35:14+02:00
id: 20230419113601 id: 20230419113601
tags: [note, markdown] tags: [note, markdown]
logo: logo:
- logo-md.svg - ../static/logo-md.svg
lang: fr lang: fr
bibliography: references.bib bibliography: ../static/references.bib
csl: heg-iso-690.csl citation-style: ../static/heg-iso-690.csl
link-citations: true link-citations: true
toc-title: Table des matières toc-title: Table des matières
--- ---
## Objectifs ## Objectifs
Les objectifs annoncés pour l'introduction sont les suivants: - Quel intérêt? Pourquoi se mettre à rédiger avec markdown?
- Comment: aperçu de la syntaxe de base.
- Quel intérêt? Autrement dit, pourquoi se mettre à rédiger avec markdown?
- Comment: syntaxe de base.
- Qu'attendre d'un éditeur de texte (pour rédiger avec markdown)? - Qu'attendre d'un éditeur de texte (pour rédiger avec markdown)?
- Bref aperçu des possibilités avancées: - Bref aperçu des possibilités avancées:
- Ensemble de notes. - Ensemble de notes.
@ -34,22 +32,249 @@ Les objectifs annoncés pour l'introduction sont les suivants:
[cc-by-sa]: https://creativecommons.org/licenses/by-sa/4.0/deed.fr "Texte de la licence en français" [cc-by-sa]: https://creativecommons.org/licenses/by-sa/4.0/deed.fr "Texte de la licence en français"
[sources]: https://git.milhit.ch/igor/rdv-info-markdown [sources]: https://git.milhit.ch/igor/rdv-info-markdown
## Pourquoi? {#1st-section} ## Pourquoi? [^0] {#1st-section}
Cette section repose essentiellement sur [@perretFormatTexte2022]. Le plus important pour *ses* propres habitudes de travail est de trouver des
méthodes et des outils adaptés à *ses besoins*. Ci-dessous sont listés quelques
arguments en faveur de l'usage de la syntaxe markdown, mais aucune méthode ou
outil n'est *la* solution miracle pertinente dans *tous* les contextes.
- Les fichiers utilisés sont: L'information numérique est utile si elle est **structurée**. Un fichier PDF
- Simples et légers. Rapides à ouvrir, faciles à sauvegarder, à synchroniser. bien conçu donne accès dans la barre latérale à la table des matières pour
Permet une recherche dans le texte rapide. faciliter la navigation. Cette structure s'obtient, par exemple, avec l'usage
- Indépendants de tout système d'exploitation et de logiciel. N'importe quel cohérent des styles et des niveaux de titre dans un traitement de texte. La
éditeur de texte (le bloc note, notepad, TextEdit, etc.). syntaxe markdown est une autre méthode, surprenante au début, mais qui s'avère
- Rend possible une gestion de version très performante (`git`). particulièrement efficace.[^1]
- Donne de bonnes assurances pour la pérennité dans le temps (archivage).
- La syntaxe étant relativement simple et facile à mémoriser, l'édition de Markdown est une syntaxe qui permet, **simplement avec des éléments textuels**,
markdown repose sur très peu de fonctionnalités du logiciel. Le bloc note de structurer (niveau de titres) et de mettre en forme du texte. Cette
suffit parfaitement, même si un peu plus de confort est souhaitable. structure et cette mise en forme sont compréhensibles par des êtres humains et
- Cette syntaxe est utilisée par de nombreux logiciels ou services en lignes par des programmes informatiques. Aussi, les documents rédigés à l'aide de
pour la rédaction. Par exemple les notes dans Zotero ou alors des éditeurs en markdown peuvent soit être lus tels quels, soit être traités par un
ligne permettant le travail collaboratif. programme pour afficher un «rendu» sous forme de page web, de document PDF ou
DOCX.
La syntaxe markdown est relativement simple à apprendre et mémoriser. Aussi, la
rédaction au format markdown repose sur très peu de fonctionnalités du
logiciel. Le bloc note suffit, même si un peu plus de confort est souhaitable.
Cette syntaxe est utilisée par de nombreux logiciels ou services en lignes pour
la rédaction. C'est le cas des notes dans Zotero ou d'éditeurs en ligne
adaptés au travail collaboratif ([HedgeDoc][hd], [HackMD][hm], etc.).
Les fichiers utilisés ne sont composés que de caractères textuels. Aussi, ils
sont:
- Simples et légers:
- Ne dépendent pas d'un logiciel spécifique, ni d'un système d'exploitation.
- Pourront être lus et édités dans n'importe quel contexte, et probablement
dans un avenir éloigné (pérennité).
- Rapides à ouvrir. Avec n'importe quel éditeur de texte (bloc note Windows,
Notepad++, TextEdit, Gedit, VIM, EMACS, etc.)
- Faciles à sauvegarder, copier, synchroniser, partager.
Toujours grâce à leur nature textuelle, il est facile d'avoir des outils pour
rechercher (et remplacer) rapidement du texte au sein non seulement du fichier
ouvert, mais d'un ensemble de fichier dans un répertoire. \
Il est même possible d'écrire des programmes pour modifier ou utiliser
automatiquement ces fichiers. Et il en existe justement beaucoup!
Grâce à ces propriétés, il est possible:
- De prendre des notes au clavier rapidement, de manière structurée, et avec
une recherche interne efficace.
- De rédiger des documents simples ou complexes, petits comme une fiche de
notes ou volumineux comme une thèse.
- De regrouper un ensemble de notes dans un «bloc note» numérique et de
naviguer rapidement dans cet ensemble, de rechercher de l'information
facilement.
- De manière similaire, de regrouper un ensemble de fichiers pour constituer un
document complexe, comme un livre ou un article scientifique.
- Enfin de convertir à partir des même fichiers le document dans plusieurs
formats pour une diffusion sur le web, la lecture dans un PDF ou un ePub.
Enfin, il y a deux arguments de *geek* :
- Les fichiers textuels sont particulièrement adaptés pour en suivre
l'historique des modification (*versioning*), par exemple avec le logiciel
[Git][git].
- Jouer avec markdown et les conversions dans de multiples format est vraiment
amusant, bien que parfois source de complications inutiles. 😅
[text]: https://www.arthurperret.fr/cours/format-texte.html
[hd]: https://hedgedoc.org/
[hm]: https://hackmd.io/
[git]: https://fr.wikipedia.org/wiki/Git "Article Wikipedia en français"
## Comment?
La syntaxe markdown est très souvent expliquée sur le web:
- La documentation «officielle» est disponible sur le site personnel d'un des
concepteurs de la syntaxe: <https://daringfireball.net/projects/markdown/>
[@gruberMarkdown2004].
- Le site *flus* propose Une documentation en français et très claire:
<https://flus.fr/carnet/markdown.html> [@fressinaudGuideMarkdown2022].
- Il y a plusieurs variantes de la syntaxe et un site essaie de proposer un
standard. Il met à disposition un tutoriel interactif:
<https://commonmark.org/help/> [@commonmarkCommonMark].
- Arthur Perret a traduit en français ce même tutoriel, disponible sur sa page
qui explique ce qu'est markdown:
<https://www.arthurperret.fr/cours/markdown.html> [@perretMarkdown2022].
Pour les tableaux, il est fortement conseillé:
- D'utiliser un générateur, par exemple
<https://www.tablesgenerator.com/markdown_tables>.
- Ou de disposer dans son éditeur d'un générateur de tableaux.
Le plus souvent les fichiers contenant du markdown ont pour extension `.md`,
mais c'est une convention. Rien n'interdit d'utiliser d'autres extensions comme
`.mkdn` ou `.markdown`, pour autant que l'éditeur que vous utilisez les
reconnaissent comme du markdown.
## Éditeurs
Il existe beaucoup d'éditeurs pour rédiger en markdown. On peut les regrouper
en deux grandes catégories:
1. Les éditeurs dédiés.
1. Les éditeurs généralistes.
Dans les deux cas, des fonctionnalités de base qui sont presque
incontournables:
- Une prévisualisation, le plus souvent sour la forme d'un *rendu* HTML.
- La possibilité de naviguer dans une arborescence de fichiers.
- Une autocomplétion, pour faciliter l'entrée de syntaxe avec des `[]` ou des
`()`.
D'autres fonctionnalités ne sont pas indispensables, mais deviennent rapidement
assez utiles:
- La correction orthographique pour les langues dans lesquelles vous rédigez.
- Un formatage automatique des tableaux.
- La possibilité de suivre les liens internes, au sein du même fichier ou entre
les fichiers d'un même répertoire.
### Éditeurs dédiés
Ce sont des logiciels conçu spécifiquement pour éditer des fichiers avec la
syntaxe markdown. Ils peuvent être sous la forme d'un logiciel à installer sur
votre appareil (ordinateur, tablette, téléphone) ou d'un service web.
**Typora** est éditeur qui met l'accent sur son interface épurée. Il est disponible
pour tous les systèmes d'exploitation, payant. <https://typora.io/>
![Interface de GhostWriter][gw]
**GhostWriter** est libre et gratuit, pour Windows et Linux
principalement.[^2] <https://ghostwriter.kde.org/fr/>
**Abricotine** est libre et gratuit, pour toutes les plateformes.
<http://abricotine.brrd.fr/>
**iA Writer** est payant, pour MacOS et Windows, mais est très apprécié pour la
rédaction. Il permet de lier des notes entre elles et offre ainsi une
navigation dans un ensemble de fichiers. <https://ia.net/writer>
**Obsidian** est un logiciel propriétaire, pour toutes les plateformes. Il ne
se limite pas à l'édition de fichiers markdown, mais permet de constituer une
base de connaissance basée sur des notes, et cela de manière très complète.
<https://obsidian.md/>
![Interface de Zettlr][zettlr]
**Zettlr** est libre et disponible pour tous les systèmes d'exploitation. Il
est destiné à un usage académique, que ce soit pour construire une base de
connaissance à partir de notes ou pour rédiger un travail de mémoire ou un
article scientifique. Il intègre Zotero pour la gestion des références.
En ligne, on peut mentionner à nouveau le service [HackMD][hm] ou le logiciel
[HedgeDoc][hd] qui permet non seulement d'éditer des fichiers mardkown avec une
prévisualisation, mais également de le faire à plusieurs, de disposer d'un
suivi des modfications et de commenter.
![Interface de l'éditeur HackMD][interface-hd]
[interface-hd]: ../static/hackmd.png
[zettlr]: ../static/zettlr.png
[gw]: ../static/ghostwriter.png
### Éditeurs généralistes
*Généralistes* car ces éditeurs ne sont pas limités à l'édition de fichier
markdown. Le plus souvent, ce sont des *éditeurs de texte*, en général utilisés
par des développeurs pour écrire du code informatique. Normalement, ils
disposent d'un écosystème d'extensions afin de s'adapter à des besoins
spécifiques. De ce fait, ils sont très puissants.
Ainsi, il est possible d'adapter à l'édition du markdown les éditeurs de texte
suivant, notamment:
- Notepad++, libre et gratuit, pour Windows.
- Visual Studio Code, gratuit, pour Windows, MacOS, Linux. Un des logiciels les
plus utilisés actuellement.
- VIM ou neovim, libre et gratuit, pour tous les systèmes d'exploitation.
- EMACS, libre et gratuit.
![Interface de Visual Studio Code][vscode]
[vscode]: ../static/vscode.png
## Aperçu des possibilités avancées
### Ensemble de notes
Afin d'organiser ses notes, il est possible de réunir un ensemble de fichiers
dans le même répertoires (y compris avec des sous répertoires) et de faire des
liens entre les fichiers (et même au sein d'un seul fichier).
Certains éditeurs, ou certaines extensions d'éditeurs, proposent des facilités
pour générer ces liens, au prix d'une syntaxe *ad hoc*. Mais il est
parfaitement possible de le faire avec la syntaxe «normale» du lien.
![Lien depuis le fichier `README.md` vers le fichier `points-a-ameliorer.md`][lienEntreFichiers]
La figure 5 montre sur la gauche une arborescence de fichiers, avec
des sous-répertoires, et dans le fichier affiché (`README.md`), un lien vers le
fichier `points-a-ameliorer.md`. Dans cet éditeur, en plaçant le curseur sur le
lien et en tapant la touche «entrée», on ouvre le fichier cible.
La figure 6 montre la recherche du terme `rdv-info` lancée sur la même
arborescence de fichiers que la figure 5, au moyen du logiciel Visual Studio
Code. Il y a 13 occurrences du terme dans 7 fichiers. Ce type de recherche est
facilité par le fait que ce sont des fichiers au format texte et se retrouve
dans la plupart des éditeurs généralistes de qualité.
![Recherche dans Visual Studio Code][rechCode]
### Export vers d'autres formats
La conversion d'un document markdown en un autre format, plus simple à partager
devient assez vite utile. Pour les conversions, `pandoc` est l'outil le plus
souvent utilisé. Il est soit utilisé par votre éditeur pour faire les exports
(par exemple avec Zettlr), soit par vous même en ligne de commande. C'est un
logiciel libre et gratuit, développé très activement.
Il est capable de lire et d'écrire dans un grand nombre de formats différents,
parfois à l'aide de logiciels spécifiques. Par exemple, pour produire un
fichier PDF, il peut utiliser plusieurs méthodes, dont LaTeX, ce qui suppose
d'en avoir une version installée.
Le support de cours de cette introduction à markdown a été rédigée en markdown
et est exportée en PDF grâce à `pandoc` et à *Paged.js*.[^3]
[lienEntreFichiers]: ../static/lien-entre-fichiers.png
[rechCode]: ../static/recherche-vscode.png
## Bibliographie ## Bibliographie
[^0]: Cette section repose beaucoup sur la page [Format texte][text]
d'Arthur Perret [@perretFormatTexte2022].
[^1]: Markdown n'est pas le seul langage de balisage léger existant, bien que
ce soit le plus répandu. D'autres sont encore plus robustes ou puissants, comme
*RestructuredText* ou *AsciiDoc*.
[^2]: Il semble possible de l'installer sur MacOS, mais n'est pas recommandé.
[^3]: Les sources et la méthode de conversion est disponible sur
<https://git.milhit.ch/igor/rdv-info-markdown>.

Binary file not shown.

After

Width:  |  Height:  |  Size: 313 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

BIN
static/hackmd.png 100644

Binary file not shown.

After

Width:  |  Height:  |  Size: 325 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

View File

Before

Width:  |  Height:  |  Size: 300 B

After

Width:  |  Height:  |  Size: 300 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 213 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

View File

@ -14,7 +14,7 @@
langid = {english}, langid = {english},
pmcid = {PMC8889237}, pmcid = {PMC8889237},
keywords = {ANOVA; Analysis of variance,AST; aspartate aminotransferase,CLSI; Clinical Laboratory Standards Institute,cmu,EHR; electronic health record,IFCC; International Federation of Clinical Chemistry and Laboratory Medicine,LC-MS/MS; Liquid chromatography tandem mass spectrometry,LIS; Laboratory informatics system,markdown,Mixtools,non lu,pubmed,R markdown,R markdown tutorial,Reference interval,RI; reference interval,SDI; Standard deviation index,SDR; Standard deviation ratio,Testo; Testosterone,TukeyHSD; Tukey multiple pairwise-comparisons,z5; Critical z-score}, keywords = {ANOVA; Analysis of variance,AST; aspartate aminotransferase,CLSI; Clinical Laboratory Standards Institute,cmu,EHR; electronic health record,IFCC; International Federation of Clinical Chemistry and Laboratory Medicine,LC-MS/MS; Liquid chromatography tandem mass spectrometry,LIS; Laboratory informatics system,markdown,Mixtools,non lu,pubmed,R markdown,R markdown tutorial,Reference interval,RI; reference interval,SDI; Standard deviation index,SDR; Standard deviation ratio,Testo; Testosterone,TukeyHSD; Tukey multiple pairwise-comparisons,z5; Critical z-score},
file = {C\:\\Users\\milhit\\Zotero\\storage\\YYP9JQTY\\Bunch_2022_Indirect reference intervals using an R pipeline.pdf} file = {/home/igor/Zotero/storage/YYP9JQTY/Bunch_2022_Indirect reference intervals using an R pipeline.pdf}
} }
@article{chapmanExpectedPosterioriScoring2022, @article{chapmanExpectedPosterioriScoring2022,
@ -34,7 +34,18 @@
langid = {english}, langid = {english},
pmcid = {PMC9166925}, pmcid = {PMC9166925},
keywords = {cmu,markdown,non lu,pubmed,R markdown}, keywords = {cmu,markdown,non lu,pubmed,R markdown},
file = {C\:\\Users\\milhit\\Zotero\\storage\\7R2KLGBS\\Chapman_2022_Expected a posteriori scoring in PROMIS(®).pdf} file = {/home/igor/Zotero/storage/7R2KLGBS/Chapman_2022_Expected a posteriori scoring in PROMIS(®).pdf}
}
@online{commonmarkCommonMark,
title = {{{CommonMark}}},
author = {CommonMark},
url = {https://commonmark.org/},
urldate = {2023-04-25},
langid = {english},
organization = {{CommonMark}},
keywords = {non lu},
file = {/home/igor/Zotero/storage/ESNTHT9H/commonmark.org.html}
} }
@article{considineToolEncourageMinimum2019, @article{considineToolEncourageMinimum2019,
@ -53,7 +64,7 @@
langid = {english}, langid = {english},
pmcid = {PMC6468746}, pmcid = {PMC6468746},
keywords = {cmu,data analysis,markdown,minimum guidelines,non lu,pubmed,R markdown,reporting,reproducibility}, keywords = {cmu,data analysis,markdown,minimum guidelines,non lu,pubmed,R markdown,reporting,reproducibility},
file = {C\:\\Users\\milhit\\Zotero\\storage\\RSRUDDYS\\Considine_Salek_2019_A Tool to Encourage Minimum Reporting Guideline Uptake for Data Analysis in.pdf} file = {/home/igor/Zotero/storage/RSRUDDYS/Considine_Salek_2019_A Tool to Encourage Minimum Reporting Guideline Uptake for Data Analysis in.pdf}
} }
@article{daasDynamicPublicationMedia2022, @article{daasDynamicPublicationMedia2022,
@ -71,7 +82,7 @@
abstract = {In this article we show how dynamic publication media and the COPASI R Connector (CoRC) can be combined in a natural and synergistic way to communicate (biochemical) models. Dynamic publication media are becoming a popular tool for authors to effectively compose and publish their work. They are built from templates and the final documents are created dynamically. In addition, they can also be interactive. Working with dynamic publication media is made easy with the programming environment R via its integration with tools such as R Markdown, Jupyter and Shiny. Additionally, the COmplex PAthway SImulator COPASI (http://www.copasi.org), a widely used biochemical modelling toolkit, is available in R through the use of the COPASI R Connector (CoRC, https://jpahle.github.io/CoRC). Models are a common tool in the mathematical biosciences, in particular kinetic models of biochemical networks in (computational) systems biology. We focus on three application areas of dynamic publication media and CoRC: Documentation (reproducible workflows), Teaching (creating self-paced lessons) and Science Communication (immersive and engaging presentation). To illustrate these, we created six dynamic document examples in the form of R Markdown and Jupyter notebooks, hosted on the platforms GitHub, shinyapps.io, Google Colaboratory. Having code and output in one place, creating documents in template-form and the option of interactivity make the combination of dynamic documents and CoRC a versatile tool. All our example documents are freely available at https://jpahle.github.io/DynamiCoRC under the Creative Commons BY 4.0 licence.}, abstract = {In this article we show how dynamic publication media and the COPASI R Connector (CoRC) can be combined in a natural and synergistic way to communicate (biochemical) models. Dynamic publication media are becoming a popular tool for authors to effectively compose and publish their work. They are built from templates and the final documents are created dynamically. In addition, they can also be interactive. Working with dynamic publication media is made easy with the programming environment R via its integration with tools such as R Markdown, Jupyter and Shiny. Additionally, the COmplex PAthway SImulator COPASI (http://www.copasi.org), a widely used biochemical modelling toolkit, is available in R through the use of the COPASI R Connector (CoRC, https://jpahle.github.io/CoRC). Models are a common tool in the mathematical biosciences, in particular kinetic models of biochemical networks in (computational) systems biology. We focus on three application areas of dynamic publication media and CoRC: Documentation (reproducible workflows), Teaching (creating self-paced lessons) and Science Communication (immersive and engaging presentation). To illustrate these, we created six dynamic document examples in the form of R Markdown and Jupyter notebooks, hosted on the platforms GitHub, shinyapps.io, Google Colaboratory. Having code and output in one place, creating documents in template-form and the option of interactivity make the combination of dynamic documents and CoRC a versatile tool. All our example documents are freely available at https://jpahle.github.io/DynamiCoRC under the Creative Commons BY 4.0 licence.},
langid = {english}, langid = {english},
keywords = {*Software,*Systems Biology,cmu,COPASI,CoRC,Dynamic publication media,Jupyter,Kinetics,markdown,non lu,pubmed,R markdown,Systems biology}, keywords = {*Software,*Systems Biology,cmu,COPASI,CoRC,Dynamic publication media,Jupyter,Kinetics,markdown,non lu,pubmed,R markdown,Systems biology},
file = {C\:\\Users\\milhit\\Zotero\\storage\\WJ5FCFZY\\Daas et al_2022_Dynamic publication media with the COPASI R Connector (CoRC).pdf} file = {/home/igor/Zotero/storage/WJ5FCFZY/Daas et al_2022_Dynamic publication media with the COPASI R Connector (CoRC).pdf}
} }
@unpublished{deletrazModeTexteMarkdown2022, @unpublished{deletrazModeTexteMarkdown2022,
@ -87,17 +98,6 @@
keywords = {markdown,non lu,pandoc,Publication scientifique} keywords = {markdown,non lu,pandoc,Publication scientifique}
} }
@unpublished{eyssetteHttpsEyssetteForge2023,
title = {https://eyssette.forge.aeif.fr/marp-slides/slides/2022-2023/utiliser-le-markdown-pour-tout-faire},
author = {Eyssette, Cédric},
date = {2023},
url = {https://eyssette.forge.aeif.fr/marp-slides/slides/2022-2023/utiliser-le-markdown-pour-tout-faire},
urldate = {2023-04-17},
langid = {fre},
keywords = {non lu},
file = {C\:\\Users\\milhit\\Zotero\\storage\\I7CTE3X5\\utiliser-le-markdown-pour-tout-faire.html}
}
@online{eyssetteUtiliserMarkdownPour2023, @online{eyssetteUtiliserMarkdownPour2023,
type = {Mastodon post}, type = {Mastodon post},
title = {Utiliser le Markdown pour tout faire.Le diaporama (fait en markdown bien sûr !) qui m'a servi de support lors de mon atelier pour la Journée…}, title = {Utiliser le Markdown pour tout faire.Le diaporama (fait en markdown bien sûr !) qui m'a servi de support lors de mon atelier pour la Journée…},
@ -109,7 +109,18 @@
langid = {french}, langid = {french},
organization = {{Mastodon}}, organization = {{Mastodon}},
keywords = {fediverse,markdown,mastodon,non lu}, keywords = {fediverse,markdown,mastodon,non lu},
file = {C\:\\Users\\milhit\\Zotero\\storage\\7FYFNED6\\110158455766516456.html} file = {/home/igor/Zotero/storage/7FYFNED6/110158455766516456.html}
}
@unpublished{eyssetteUtiliserMarkdownPour2023a,
title = {Utiliser le markdown pour tout faire},
author = {Eyssette, Cédric},
date = {2023},
url = {https://eyssette.forge.aeif.fr/marp-slides/slides/2022-2023/utiliser-le-markdown-pour-tout-faire},
urldate = {2023-04-17},
langid = {fre},
keywords = {non lu},
file = {/home/igor/Zotero/storage/I7CTE3X5/utiliser-le-markdown-pour-tout-faire.html}
} }
@online{fressinaudGuideMarkdown2022, @online{fressinaudGuideMarkdown2022,
@ -123,7 +134,7 @@
langid = {fre}, langid = {fre},
organization = {{flus}}, organization = {{flus}},
keywords = {documentation,markdown,non lu}, keywords = {documentation,markdown,non lu},
file = {C\:\\Users\\milhit\\Zotero\\storage\\96VGWVYV\\markdown.html} file = {/home/igor/Zotero/storage/96VGWVYV/markdown.html}
} }
@article{graysonMarkdownDynamicInterface2022, @article{graysonMarkdownDynamicInterface2022,
@ -142,7 +153,7 @@
langid = {english}, langid = {english},
pmcid = {PMC9487201}, pmcid = {PMC9487201},
keywords = {*Learning,*Students,Biology/education,cmu,Data visualization,Herd immunity,Humans,markdown,non lu,Pedagogy,pubmed,R markdown,Teaching programming}, keywords = {*Learning,*Students,Biology/education,cmu,Data visualization,Herd immunity,Humans,markdown,non lu,Pedagogy,pubmed,R markdown,Teaching programming},
file = {C\:\\Users\\milhit\\Zotero\\storage\\JQGHBHB5\\Grayson et al_2022_R Markdown as a dynamic interface for teaching.pdf} file = {/home/igor/Zotero/storage/JQGHBHB5/Grayson et al_2022_R Markdown as a dynamic interface for teaching.pdf}
} }
@online{gruberMarkdown2004, @online{gruberMarkdown2004,
@ -155,7 +166,7 @@
langid = {english}, langid = {english},
organization = {{Daring Fireball}}, organization = {{Daring Fireball}},
keywords = {documentation,markdown,non lu}, keywords = {documentation,markdown,non lu},
file = {C\:\\Users\\milhit\\Zotero\\storage\\J7WP5B3D\\markdown.html} file = {/home/igor/Zotero/storage/J7WP5B3D/markdown.html}
} }
@article{hershbergJBrowseRInterfaceJBrowse2021, @article{hershbergJBrowseRInterfaceJBrowse2021,
@ -175,7 +186,7 @@
langid = {english}, langid = {english},
pmcid = {PMC8570803}, pmcid = {PMC8570803},
keywords = {*Genome,*Genomics,cmu,markdown,non lu,pubmed,R markdown,Software}, keywords = {*Genome,*Genomics,cmu,markdown,non lu,pubmed,R markdown,Software},
file = {C\:\\Users\\milhit\\Zotero\\storage\\LYEIF748\\Hershberg et al_2021_JBrowseR.pdf} file = {/home/igor/Zotero/storage/LYEIF748/Hershberg et al_2021_JBrowseR.pdf}
} }
@article{jaglaSCHNAPPsSingleCell2021, @article{jaglaSCHNAPPsSingleCell2021,
@ -193,7 +204,7 @@
abstract = {Single-cell RNA-sequencing (scRNAseq) experiments are becoming a standard tool for bench-scientists to explore the cellular diversity present in all tissues. Data produced by scRNAseq is technically complex and requires analytical workflows that are an active field of bioinformatics research, whereas a wealth of biological background knowledge is needed to guide the investigation. Thus, there is an increasing need to develop applications geared towards bench-scientists to help them abstract the technical challenges of the analysis so that they can focus on the science at play. It is also expected that such applications should support closer collaboration between bioinformaticians and bench-scientists by providing reproducible science tools. We present SCHNAPPs, a Graphical User Interface (GUI), designed to enable bench-scientists to autonomously explore and interpret scRNAseq data and associated annotations. The R/Shiny-based application allows following different steps of scRNAseq analysis workflows from Seurat or Scran packages: performing quality control on cells and genes, normalizing the expression matrix, integrating different samples, dimension reduction, clustering, and differential gene expression analysis. Visualization tools for exploring each step of the process include violin plots, 2D projections, Box-plots, alluvial plots, and histograms. An R-markdown report can be generated that tracks modifications and selected visualizations. The modular design of the tool allows it to easily integrate new visualizations and analyses by bioinformaticians. We illustrate the main features of the tool by applying it to the characterization of T cells in a scRNAseq and Cellular Indexing of Transcriptomes and Epitopes by Sequencing (CITE-Seq) experiment of two healthy individuals.}, abstract = {Single-cell RNA-sequencing (scRNAseq) experiments are becoming a standard tool for bench-scientists to explore the cellular diversity present in all tissues. Data produced by scRNAseq is technically complex and requires analytical workflows that are an active field of bioinformatics research, whereas a wealth of biological background knowledge is needed to guide the investigation. Thus, there is an increasing need to develop applications geared towards bench-scientists to help them abstract the technical challenges of the analysis so that they can focus on the science at play. It is also expected that such applications should support closer collaboration between bioinformaticians and bench-scientists by providing reproducible science tools. We present SCHNAPPs, a Graphical User Interface (GUI), designed to enable bench-scientists to autonomously explore and interpret scRNAseq data and associated annotations. The R/Shiny-based application allows following different steps of scRNAseq analysis workflows from Seurat or Scran packages: performing quality control on cells and genes, normalizing the expression matrix, integrating different samples, dimension reduction, clustering, and differential gene expression analysis. Visualization tools for exploring each step of the process include violin plots, 2D projections, Box-plots, alluvial plots, and histograms. An R-markdown report can be generated that tracks modifications and selected visualizations. The modular design of the tool allows it to easily integrate new visualizations and analyses by bioinformaticians. We illustrate the main features of the tool by applying it to the characterization of T cells in a scRNAseq and Cellular Indexing of Transcriptomes and Epitopes by Sequencing (CITE-Seq) experiment of two healthy individuals.},
langid = {english}, langid = {english},
keywords = {*Sequence Analysis; RNA,*Single-Cell Analysis,*Software,CITE-Seq,cmu,Humans,Leukocytes; Mononuclear/*cytology/immunology,markdown,multi-omics data analysis,non lu,pubmed,R markdown,scRNA-seq,Shiny application}, keywords = {*Sequence Analysis; RNA,*Single-Cell Analysis,*Software,CITE-Seq,cmu,Humans,Leukocytes; Mononuclear/*cytology/immunology,markdown,multi-omics data analysis,non lu,pubmed,R markdown,scRNA-seq,Shiny application},
file = {C\:\\Users\\milhit\\Zotero\\storage\\PEARJ76P\\Jagla et al_2021_SCHNAPPs - Single Cell sHiNy APPlication(s).pdf} file = {/home/igor/Zotero/storage/PEARJ76P/Jagla et al_2021_SCHNAPPs - Single Cell sHiNy APPlication(s).pdf}
} }
@article{kariyawasamDashboardstyleInteractivePlots2021, @article{kariyawasamDashboardstyleInteractivePlots2021,
@ -213,7 +224,7 @@
langid = {english}, langid = {english},
pmcid = {PMC8693569}, pmcid = {PMC8693569},
keywords = {cmu,markdown,non lu,pubmed,R markdown}, keywords = {cmu,markdown,non lu,pubmed,R markdown},
file = {C\:\\Users\\milhit\\Zotero\\storage\\ZQD2WXNN\\Kariyawasam et al_2021_Dashboard-style interactive plots for RNA-seq analysis are R Markdown ready.pdf} file = {/home/igor/Zotero/storage/ZQD2WXNN/Kariyawasam et al_2021_Dashboard-style interactive plots for RNA-seq analysis are R Markdown ready.pdf}
} }
@online{pandocWritingThesisThinking2023, @online{pandocWritingThesisThinking2023,
@ -228,7 +239,7 @@
langid = {english}, langid = {english},
organization = {{Mastodon}}, organization = {{Mastodon}},
keywords = {fediverse,markdown,mastodon,non lu,pandoc,Publication scientifique}, keywords = {fediverse,markdown,mastodon,non lu,pandoc,Publication scientifique},
file = {C\:\\Users\\milhit\\Zotero\\storage\\T354LYSW\\110184589069297715.html} file = {/home/igor/Zotero/storage/T354LYSW/110184589069297715.html}
} }
@online{perretFormatTexte2022, @online{perretFormatTexte2022,
@ -248,7 +259,7 @@
[C]est un fichier qui ne contient des caractères. (Perret, 2022) [C]est un fichier qui ne contient des caractères. (Perret, 2022)
\par \par
\end{quotation}}, \end{quotation}},
file = {C\:\\Users\\milhit\\Zotero\\storage\\3IM8K4DU\\format-texte.html} file = {/home/igor/Zotero/storage/3IM8K4DU/format-texte.html}
} }
@online{perretMarkdown2022, @online{perretMarkdown2022,
@ -263,7 +274,7 @@
langid = {french}, langid = {french},
organization = {{Arthur Perret}}, organization = {{Arthur Perret}},
keywords = {documentation,markdown,non lu}, keywords = {documentation,markdown,non lu},
file = {C\:\\Users\\milhit\\Zotero\\storage\\HZNSDQ7S\\markdown.html} file = {/home/igor/Zotero/storage/HZNSDQ7S/markdown.html}
} }
@software{pollardTemplateWritingPhD2023, @software{pollardTemplateWritingPhD2023,
@ -312,5 +323,5 @@
langid = {english}, langid = {english},
pmcid = {PMC7049126}, pmcid = {PMC7049126},
keywords = {cmu,computation,data science,markdown,non lu,prediction,pubmed,R markdown,stability}, keywords = {cmu,computation,data science,markdown,non lu,prediction,pubmed,R markdown,stability},
file = {C\:\\Users\\milhit\\Zotero\\storage\\GWVCYDA6\\Yu_Kumbier_2020_Veridical data science.pdf} file = {/home/igor/Zotero/storage/GWVCYDA6/Yu_Kumbier_2020_Veridical data science.pdf}
} }

BIN
static/vscode.png 100644

Binary file not shown.

After

Width:  |  Height:  |  Size: 195 KiB

BIN
static/zettlr.png 100644

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

View File

@ -1,6 +1,6 @@
@media print { @media print {
body { body {
font-family: TheSans, "Open Sans", Arial, Helvetica, sans-serif; font-family: TheSansOsF-Plain, "Open Sans", Arial, Helvetica, sans-serif;
counter-reset: figureNumber; counter-reset: figureNumber;
} }
/* Définit que string(date) contient la date */ /* Définit que string(date) contient la date */
@ -96,6 +96,9 @@
font-size: 120%; font-size: 120%;
font-weight: bold; font-weight: bold;
} }
.footnote-ref {
text-decoration: none;
}
figure { figure {
display: flex; display: flex;
flex-direction: column; flex-direction: column;