From 42057d26b1bc3bce99669e8f4c953068af007950 Mon Sep 17 00:00:00 2001 From: Stefan Pinnow Date: Tue, 19 Apr 2022 07:18:28 +0200 Subject: [PATCH 1/5] doc: fix markdownlint violations --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1fc88fe..5d2743f 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ by [Manning Publications Co.](https://www.manning.com/). In order to prepare the Julia environment before working with the materials presented in the book please perform the following setup steps: + * [download](https://julialang.org/downloads/) and [install](https://julialang.org/downloads/platform/) [Julia](https://julialang.org/); @@ -32,6 +33,7 @@ presented in the book please perform the following setup steps: Additional instructions how to manage your Julia installation are given in Appendix A to the book. In particular I explain there how to perform a correct configuration of your environment when doing: + * integration with Python using the PyCall.jl package; * integration with R using the RCall.jl package; * installation of Plots.jl (which by default uses the GR Framework that requires @@ -54,11 +56,12 @@ you extracted Julia in, for example, the `/opt` folder, the simplest way to make sure that your system can find `julia` executable is to add it to your system `PATH` environment variable. A standard way to do it is to edit your `~/.bashrc` (or `~/.bash_profile`) file and add there the: -``` + +```text export PATH="$PATH:/opt/julia-1.7.2/bin" ``` -line (assuming you have downloaded Julia 1.7.2 and extracted it to `/opt` folder). +line (assuming you have downloaded Julia 1.7.2 and extracted it to `/opt` folder). ## Organization of the code @@ -77,6 +80,7 @@ and appropriate packages are loaded). ## Running the example codes To work with codes from some given chapter: + * it is recommended to use a machine with at least 8GB of RAM when working with the examples in this book; * start a fresh Julia session using the `julia --project` command in a folder @@ -95,13 +99,14 @@ To work with codes from some given chapter: For your convenience I additionally stored data files that we use in this book. They are respectively: + * movies.dat (for chapter 6, shared on GitHub repository - https://github.com/sidooms/MovieTweetings under MIT license) + under MIT license) * puzzles.csv.bz2 (for chapter 8, available puzzles at - https://database.lichess.org/. The data is distributed under + . The data is distributed under Creative Commons CC0 license) * git_web_ml.zip (for chapter 12, available on Stanford Large Network Dataset Collection website - https://snap.stanford.edu/data/github-social.html under GPL-3.0 License) + under GPL-3.0 License) * owensboro.zip (for chapter 13, available at The Stanford Open Policing Project under the Open Data Commons Attribution License) From 82e05ff6a39958d5d7c560c2c7bb20e54deb59d5 Mon Sep 17 00:00:00 2001 From: Stefan Pinnow Date: Tue, 19 Apr 2022 07:22:32 +0200 Subject: [PATCH 2/5] doc: use `` tag --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5d2743f..ad211b6 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,12 @@ presented in the book please perform the following setup steps: you to work with material presented in this book (a more detailed explanation what these files do and why they are required is given in Appendix A to the book); -* press *]*, write `instantiate` and press *Enter* (this process will ensure - that Julia properly configures the working environment for working with - the codes from the book); -* press *Backspace*, write `exit()` and press *Enter*; now you should exit Julia - and everything is set up to work with the materials presented in the book. +* press ], write `instantiate` and press Enter (this + process will ensure that Julia properly configures the working environment + for working with the codes from the book); +* press Backspace, write `exit()` and press Enter; + now you should exit Julia and everything is set up to work with the materials + presented in the book. Additional instructions how to manage your Julia installation are given in Appendix A to the book. In particular I explain there how to perform a correct @@ -44,7 +45,8 @@ In particular, if you use [Julia extension](https://marketplace.visualstudio.com/items?itemName=julialang.language-julia) then open the folder with the materials contained in this repository (you can open it in Folder/Open Folder... menu option). Then if you run -*Start Julia REPL* command (e.g. under Windows its keyboard shortcut is Alt-J Alt-O) +*Start Julia REPL* command (e.g. under Windows its keyboard shortcut is +Alt-J Alt-O) a proper project environment will be automatically activated (the Julia extension will use the Project.toml and Manifest.toml files that are present in this folder). @@ -110,3 +112,5 @@ They are respectively: under GPL-3.0 License) * owensboro.zip (for chapter 13, available at The Stanford Open Policing Project under the Open Data Commons Attribution License) + + From 3dd846548b25fdd81462744edf87d2dbb4500b96 Mon Sep 17 00:00:00 2001 From: Stefan Pinnow Date: Tue, 19 Apr 2022 07:29:12 +0200 Subject: [PATCH 3/5] doc: harmonize appendix --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ad211b6..b5861d7 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ presented in the book please perform the following setup steps: allow Julia to automatically set up the project environment that will allow you to work with material presented in this book (a more detailed explanation what these files do and why they are required is - given in Appendix A to the book); + given in appendix A to the book); * press ], write `instantiate` and press Enter (this process will ensure that Julia properly configures the working environment for working with the codes from the book); @@ -32,7 +32,7 @@ presented in the book please perform the following setup steps: presented in the book. Additional instructions how to manage your Julia installation are given in -Appendix A to the book. In particular I explain there how to perform a correct +appendix A to the book. In particular I explain there how to perform a correct configuration of your environment when doing: * integration with Python using the PyCall.jl package; From 0ca407d3d47802b45e0fc7ac6502b7d565a80ab1 Mon Sep 17 00:00:00 2001 From: Stefan Pinnow Date: Tue, 19 Apr 2022 07:32:19 +0200 Subject: [PATCH 4/5] doc: fix double dot --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b5861d7..fb310e2 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ This repository contains source codes for the ["Julia for Data Analysis"](https://www.manning.com/books/julia-for-data-analysis?utm_source=bkamins&utm_medium=affiliate&utm_campaign=book_kaminski2_julia_3_17_22) book that is written by Bogumił Kamiński and is planned to be published in 2022 -by [Manning Publications Co.](https://www.manning.com/). +by [Manning Publications Co.](https://www.manning.com/) ## Setting up your environment From 28af42c8fb30bb56569281c9d2978ad76069e3b8 Mon Sep 17 00:00:00 2001 From: Stefan Pinnow Date: Tue, 19 Apr 2022 07:41:49 +0200 Subject: [PATCH 5/5] chore: fix typo --- ch12.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ch12.jl b/ch12.jl index bd1fe91..98878f4 100644 --- a/ch12.jl +++ b/ch12.jl @@ -24,7 +24,7 @@ open(sha256, git_zip) == [0x56, 0xc0, 0xc1, 0xc2, 0x1d, 0x07, 0x3b, 0x10, 0xe2, 0x8e, 0xc0, 0x31] -# Code for opeining a zip archive +# Code for opening a zip archive import ZipFile git_archive = ZipFile.Reader(git_zip)