Skip to content

Commit

Permalink
minor doc
Browse files Browse the repository at this point in the history
  • Loading branch information
cbielow committed Nov 3, 2015
1 parent 484c84e commit 7a98a1f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ you can browse the vignettes using either of these commands within R:
browseVignettes(package = 'PTXQC')

If you do not want to wait that long, have a look at the ['vignettes' subfolder] [3].
The top part contains some technical gibberish, but the rest is identical to the
The top part contains a small table with technical gibberish, but the rest is identical to the
vignettes you would see in R.

You will find documentation on
Expand Down Expand Up @@ -104,3 +104,5 @@ For example input data and full reports, see the ['inst/examples' subfolder] [2]
### Citation

The paper is currently under review. A DOI and link will be provided here (soon?)! :)

The data used therein is available in the ['inst/examples' subfolder] [2].
6 changes: 4 additions & 2 deletions vignettes/readme.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
This folder contains the package vignettes in Markdown (.md files).
This folder contains the package vignettes in Markdown (.Rmd files).

When the package is build, R/knitr will automatically create 'proper' vignette files,
which end up as HTML in PTXQC/doc/*.html.

On GitHub, you can just open any of the vignettes and they will be displayed as HTML in your browser.

Thoughts on GitHub:

Technical thoughts on GitHub:

Since this package is also hosted on GitHub, vignettes can be directly viewed 'raw' by just browsing to this directory (PTXQC/vignettes).
GitHub has a nice feature, which renders the Markdown header as table (instead of displaying the YAML text or ugly LaTex commands).
Expand Down

0 comments on commit 7a98a1f

Please sign in to comment.