published on 17.04.2022
edited on 15.07.2022

Önceki bölümde, markdown formatını LaTeX formatına dönüştürmek için kullanılan Pandoc yazılımından bahsetmiştik. Şimdi konuyu bir adım daha ileri taşıyıp ve bookdown’a geçiyoruz. Bookdown; Rmarkdown kullanarak teknik dökümanlar, kitaplar yazabilmemizi sağlayan, Yihui Xie tarafından yazılmış fantastik bir R paketidir. Bookdown’a geçmeden önce adım adım konuyu anlatacağım.

rstudio.png

R paketlerinden bahsettiğimize göre, her şeyden önce bilgisayarımızda R yüklü olmalı. Bağlantıdan yükleyebilirsiniz. Buralar kolay. Next. Next. Finish. RStudio ‘da yükleminizi tavsiye ederim, işinizi kolaylaştırmak adına. Gerçi RStudio olmadan da herhangi bir kod editor kullanıp konsol üzerinden R komutlarını çalıştırabilirsiniz. Ben VS Code ve terminal kullanıyorum mesela; kısayollarına vs. alıştığım için. Söylediklerim karışık geliyorsa, RStudio yüklemeniz en kolay seçenek. RStudio kullanarak, RMarkdown dosyalarınızı düzenleyebilir, arayüzden butonlara basarak birazdan anlatacağım paketlerin yeteneklerinden faydalanabilirsiniz.

rmarkdown.png

Daha önce hiç RMarkdown kullanmadığınızı varsayarak, genel konsepti özetlemeye çalışacağım. RMarkdown, standart markdowndandan farklı olarak, yazdığımız kod bloklarını R ile çalıştırabilmemize olanak sağlıyor. Hatta R dışında farklı diller için de kod blokları tanımlayabilmek mümkün; sql ya da python gibi. Daha önce Jupyter Notebook kullandıysanız, benzer konseptler olarak değerlendirebilirsiniz, tabii önemli farkları var ama burada detaya girmiyorum. En azından kod bloğu kısmını benzer olarak değerlendirebilirsiniz. Tez yazarken ya da teknik bir döküman yazarken kod blokları büyük olasılıkla umrumuzda olmayacak ama tablo ve resim gibi içerikler kullanırken kullanıbilecek fonksiyonlar ve paketler var. Tıpkı LaTeX’de olduğu gibi.

Bir Rmarkdown dosyasının üç bölümden oluştuğunu söyleyebiliriz. Kod blokları, düz yazı ve front-matter. Yazı bölümü, markdown formatında. Kod blokları, Rmarkdown dosyasını renderlarken çalışacak ve outputları renderlanacak. Örneğin, kod bloğunda veri analizi yapıp bir tablo ya da grafiği çıktı olarak alabilirsiniz. “Front-matter” dediğimiz yer, dosyada içeriğe başlamadan önceki alan. YAML metadata da denir bu bölüme. YAML formatında dökumana ait bazı veriler burada tanımlanabilir, örneğin ‘author’, ‘date’ gibi standart alanlar. Ayrıca parametreler tanımlayıp kod blokları içerisinde bu parametreleri kullanmamız da mümkün. Böylece reproducible parameterized raporlar hazırlayabiliriz.

knitr.png

RStudio üzerinden, knit butonuna tıklayarak Rmarkdown dosyanızı derleyebilirsiniz. HTML, PDF ya da Word formatında çıktı alabilirsiniz. PDF için tabii ki LaTeX formatını derleyebilecek bir yazılıma da ihtiyacınız olacak ama PDF’e ihtiyacınız yoksa LaTeX’e de ihtiyacınız yok. Burada knitr paketi görev alıyor. Knitr, Rmarkdown dosyasındaki kod bloklarını çalıştırıyor, ve kod bloğunda belirtilen kurallara göre (code chunk options) çıktıyı yeni dökümana işliyor. Sonuçta Rmarkdown dosyasından markdown dosyası .Rmd -> .md oluşturuyor. Oluşan markdown dosyası da Pandoc kullanılarak istediğiniz formata dönüştürülüyor.

latex_project_logo.png

Akademik bir çalışma yapıyorsanız ya da herhangi bir nedenle PDF formatında çıktıya ihtiyacınız varsa, LaTeX zaten şart. Her ne kadar biz direkt LaTeX formatında yazmayacak olsak da, bilgisayarımızda yüklü olmalı ki sonuçta PDF çıktısı alabilelim. Farklı platformlarda farklı dağıtımları LaTeX dağıtımları mevcut. Windows kullanıyorsanız MikTeX, aksi halde buradan bakınız. TinyTeX de bir seçenek. Önce TinyTeX denemenizi tavsiye ederim. Çünkü boyutu çok daha küçük ve kolayca yükleyebileceğiniz bir R paketi. Benim için nedense işler pek yolunda gitmemişti ve MikTeX yüklemek zorunda kalmıştım.


Böylece temel konsepti anlatmış olduk. Buraya kadar paketlerin yüklenmesinde bir sorun yaşamadıysanız, RStudio üzerinden knit butonuna basarak bir Rmarkdown dosyasını HTML ve PDF formatında derleyebiliyor olmalısınız. Umarım her şey yolunda gitmiştir.

bookdown.png

Sonraki durak: Bookdown. Bookdown’da konsept aynı, Rmarkdown kullanarak bir döküman ya da websitesi oluşturacağız ancak akademik yayın ya da tez gibi uzun ve detaylı bir içerik üzerine çalıştığımız için, bu dökümanın belirli bir formatta olmasını, birden fazla bölümün belki alt bölümlerin olmasını istiyoruz. Birden fazla Rmarkdown dosyasını sistematik bir şekilde işleyecek ve istediğimiz çıktıyı verecek paket ise bookdown.

bookdown_workflow.png

Hızlı bir demo için, RStudio üzerinden yeni bir bookdown projesi oluşturarak örnek bir proje ile başlayabilirsiniz. Daha önce yaptığınız gibi, “Knit to HTML” ya da “Knit to PDF” seçenekleri ile örnek projeyi derleyebilirsiniz. Projede iki YAML dosyası olacak, _bookdown.yaml ve _output.yaml. Bir de index.Rmd‘nin front-matter kısmını da sayarsak üç YAML dosyası var diyebiliriz. Bu dosyalarda çeşitli konfigurasyonlar yapmak ya da parametreler tanımlamak mümkün. Farklı çıktı tipleri için ayarlar yapabilir, özelleştirebilirsiniz. .bibtex dosyalarınızı tanıtıp istediğiniz formatta (APA, IEEE vb.) kaynakça oluşturabilirsiniz. Bölümlere, tablolara, resimlere cross referans bağlantılar koyabilirsiniz. Bookdown sınırsız olanak sunuyor bize, hepsini tek seferde öğrenmek ya da akılda tutmak mümkün değil, onun için her zaman dökümantasyona bakmak gerekecek. Özellikle ilk aşamada. Neyse ki başımız sıkıştığında bakabileceğimiz iyi kaynaklar var, iki kaynağı burada paylaşıyorum, elinizin altında bulunsun:

Bir sonraki yazıda bookdown ile ilgili öğrendiğim kayda değer birkaç ipucu paylaşacağım.

You are reading the 3rd of 3 episodes in Writing-Thesis.
Published on 17.04.2022 by Mert Bakır. Last update on 15.07.2022 with commit f142d2f.
writing-thesis
#rmarkdown
published on 10.07.2022

Previously, I’ve published a blog post about deploying static content on heroku with basic authentication. You can find the link here. In that post, we hosted the source code on GitLab and configured a CI/CD pipeline to render the static content a.k.a html files and push these files to Heroku. …

published on 28.05.2022

Each git commit has a field called Author which consists ‘user.name’ and ‘user.email’. We usually set these variables once, after installing git, with git config --global so that each repo gets the variables from the global definition. We can also set them locally for a …

published on 25.05.2022

In this post, I’ll first walk through hosting static content with basic authentication. Then, we’ll look into deploying to Heroku using GitLab Pipelines, more specifically deploying a certain sub-directory within the project instead of pushing the whole project. Also, I’ll share …

published on 10.04.2022

I’ve been using WSL-2 on Windows for over a year. It’s very useful because some Python packages are just a headache to install on Windows. Also, docker. It’s just better on Linux. Yet, WSL-2 can also be problematic. I remember trying a dual-boot setup when things just went way too …

published on 03.03.2022

In this post, I’ll share how to install geopandas and some other gis related packages on Windows. If you are on Mac or Linux you can probably just pip install those without any issue. I usually had to do a google search every time I wanted to install these packages on Windows environment. Of …