Skip to content

Commit da906ae

Browse files
committed
adapted to pdf-conversion
1 parent 9a08cf0 commit da906ae

File tree

7 files changed

+1054
-6
lines changed

7 files changed

+1054
-6
lines changed

.github/workflows/addPDF.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
sed -i '1,/^\s*## Guide for/ {/## Guide for/ !d}' trident.md
3434
sed -i '1,/^\s*## Guide for/ {/## Guide for/ !d}' xerxes.md
3535
# add extra # at the beginning of janno_details.md
36-
echo -e "#$(cat janno_details.md)" > janno_details.md
36+
# echo -e "#$(cat janno_details.md)" > janno_details.md
3737
3838
- name: Convert files
3939
run: |

janno_r_package.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<popup :custom-text="`<p><a href='https://nevrome.github.io/uni.tuebingen.poseidon.intro.2h.2024'>A short introduction to the Poseidon genotype data management framework</a> by Clemens Schmid: A Poseidon tutorial also covering <a href='https://nevrome.github.io/uni.tuebingen.poseidon.intro.2h.2024/spacetime.html'>the janno R package</a></p>`"></popup>
22

3-
# janno R package
3+
<h1>janno R package</h1>
44

55
`janno` (formerly known as poseidonR) is an R package to simplify the interaction with `.janno` files in Poseidon packages. It provides a dedicated R S3 class `janno` that inherits from `tibble` and allows to tidily read and manipulate the context information stored in them. The code is available on [GitHub](https://github.com/poseidon-framework/janno/).
66

@@ -15,6 +15,8 @@ The guide below explains the main functions in the package. It is available in .
1515

1616
- [🗎 Guide for the janno R package v1.0.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/janno_r_package.pdf) (shown below)
1717

18+
# Guide for the janno R package v1.0.0
19+
1820
## Installation
1921

2022
See the Poseidon website (<https://www.poseidon-adna.org/#/janno_r_package>) or the GitHub repository (<https://github.com/poseidon-framework/janno>) for up-to-date installation instructions.

pdf_conversion/pandoc_pdf_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
table-of-contents: true
2-
shift-heading-level-by: -2
2+
shift-heading-level-by: -1
33
number-sections: true
44
highlight-style: tango
55
variables:

pdf_tests/trident.md

Lines changed: 1040 additions & 0 deletions
Large diffs are not rendered by default.

qjanno.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# qjanno CLI software
1+
<h1>qjanno CLI software</h1>
22

33
`qjanno` is a command line tool to run SQL queries on `.janno` (and arbitrary .csv and .tsv) files. This is an adjusted version and hard fork of the qsh package (https://github.com/itchyny/qhs). It is written in Haskell and openly available on [GitHub](https://github.com/poseidon-framework/qjanno/).
44

@@ -29,6 +29,8 @@ The guide below explains the inner workings of qjanno and gives some examples fo
2929
- [🗎 Guide for qjanno v1.0.0.0 to v1.0.0.1](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/qjanno.pdf) (shown below)
3030
- [🗎 Guide for qjanno v1.0.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/qjanno_guide_archive/qjanno_guide_1.0.0.pdf)
3131

32+
# Guide for qjanno v1.0.0.0 to v1.0.0.1
33+
3234
## Background
3335

3436
Qjanno started as a fork of the [qhs](https://github.com/itchyny/qhs) software tool, which was, in turn, inspired by the command line tool [q](https://github.com/harelba/q). All of them enable SQL queries on delimiter-separated text files (e.g. .csv or .tsv). For `qjanno`, we copied the source code of qhs v0.3.3 (MIT-License) and adjusted it to provide a smooth experience with a special kind of .tsv file: The Poseidon `.janno` file.

trident.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<popup :custom-text="`<p><a href='https://nevrome.github.io/uni.tuebingen.poseidon.intro.2h.2024'>A short introduction to the Poseidon genotype data management framework</a> by Clemens Schmid: A Poseidon tutorial showcasing the <a href='https://nevrome.github.io/uni.tuebingen.poseidon.intro.2h.2024/ref_pca.html'>main features of trident</a> among other things</p>`"></popup>
22

3-
# trident CLI software
3+
<h1>trident CLI software</h1>
44

55
`trident` is a command line software tool to work with Poseidon packages and handle various data management tasks. It is written in Haskell and openly available on [GitHub](https://github.com/poseidon-framework/poseidon-hs/).
66

@@ -44,6 +44,8 @@ With `trident --help` and `trident <subcommand> --help` you can get information
4444
- [🗎 Guide for trident v0.29.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/trident_guide_archive/trident_guide_0.29.0.pdf)
4545
- [🗎 Guide for trident v0.28.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/trident_guide_archive/trident_guide_0.28.0.pdf)
4646

47+
# Guide for trident v1.5.4.0
48+
4749
## Installation
4850

4951
See the Poseidon website (<https://www.poseidon-adna.org/#/trident>) or the GitHub repository (<https://github.com/poseidon-framework/poseidon-hs>) for up-to-date installation instructions.

xerxes.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<popup :custom-text="`<p><a href='https://mpi-eva-archaeogenetics.github.io/comp_human_adna_book/fstats.html'>Introduction to F3- and F4-Statistics</a> by Stephan Schiffels: An explanation of F-Statistics and how to run them with xerxes</p>`"></popup>
22

3-
# xerxes CLI software
3+
<h1>xerxes CLI software</h1>
44

55
`xerxes` is a command line software tool for population genetic analyses of Poseidon packages. It is written in Haskell and openly available on [GitHub](https://github.com/poseidon-framework/poseidon-analysis-hs/).
66

@@ -35,6 +35,8 @@ With `xerxes --help` and `xerxes <subcommand> --help` you can get information ab
3535
- [🗎 Guide for xerxes v1.0.0.2](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes_guide_archive/xerxes_guide_1.0.0.2.pdf)
3636
- [🗎 Guide for xerxes v0.2.0.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes_guide_archive/xerxes_guide_0.2.0.0.pdf)
3737

38+
# Guide for xerxes v1.0.1.0 to v1.0.1.1
39+
3840
## Installation
3941

4042
See the Poseidon website (<https://www.poseidon-adna.org/#/xerxes>) or the GitHub repository (<https://github.com/poseidon-framework/poseidon-analysis-hs>) for up-to-date installation instructions.

0 commit comments

Comments
 (0)