Added vignette with algo description (#11)

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: ClustImpute
 Type: Package
 Title: K-means clustering with build-in missing data imputation
-Version: 0.1.5
+Version: 0.1.6
 Author: Oliver Pfaffel
 Maintainer: Oliver Pfaffel <[email protected]>
 Description: This clustering algorithm deals with missing data via weights that are imposed on missings and successively increased. See the vignette for details.

NEWS.md

@@ -1,3 +1,7 @@
+# ClustImpute 0.1.6
+
+* Added vignette that describes the algorithm in more detail.
+
 # ClustImpute 0.1.5
 
 * Only relevant functions are exported

pkg_pipeline.R

@@ -85,3 +85,9 @@ use_build_ignore("travis.yml")
 
 use_coverage()
 use_build_ignore("codecov.yml")
+
+
+#### Tinytex ####
+
+# Installing latex packages
+tinytex::tlmgr_install("pdfpages")

vignettes/description_of_algorithm-concordance.tex

@@ -0,0 +1,2 @@
+\Sconcordance{concordance:description_of_algorithm.tex:description_of_algorithm.Rnw:%
+1 5 1 1 0 3 1}

vignettes/description_of_algorithm.Rnw

@@ -0,0 +1,9 @@
+%\VignetteIndexEntry{Description of the algorithm}
+%\VignetteAuthor{Oliver Pfaffel}
+
+\documentclass{article}
+\usepackage{pdfpages}
+\begin{document}
+\SweaveOpts{concordance=TRUE}
+\includepdf[pages=-, fitpaper=true]{ClustImpute_description.pdf}
+\end{document}

vignettes/description_of_algorithm.log

@@ -0,0 +1,314 @@
+This is pdfTeX, Version 3.14159265-2.6-1.40.21 (TeX Live 2020/W32TeX) (preloaded format=pdflatex 2020.12.12)  12 DEC 2020 15:21
+entering extended mode
+ restricted \write18 enabled.
+ %&-line parsing enabled.
+**description_of_algorithm.tex
+(./description_of_algorithm.tex
+LaTeX2e <2020-10-01> patch level 2
+L3 programming layer <2020-12-07> xparse <2020-03-03>
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/base/article.cls
+Document Class: article 2020/04/10 v1.4m Standard LaTeX document class
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/base/size10.clo
+File: size10.clo 2020/04/10 v1.4m Standard LaTeX file (size option)
+)
+\c@part=\count177
+\c@section=\count178
+\c@subsection=\count179
+\c@subsubsection=\count180
+\c@paragraph=\count181
+\c@subparagraph=\count182
+\c@figure=\count183
+\c@table=\count184
+\abovecaptionskip=\skip47
+\belowcaptionskip=\skip48
+\bibindent=\dimen138
+)
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/pdfpages/pdfpages.
+sty
+Package: pdfpages 2020/01/28 v0.5q Insert pages of external PDF documents (AM)
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/base/ifthen.sty
+Package: ifthen 2014/09/29 v1.1c Standard LaTeX ifthen package (DPC)
+)
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/tools/calc.sty
+Package: calc 2017/05/25 v4.3 Infix arithmetic (KKT,FJ)
+\calc@Acount=\count185
+\calc@Bcount=\count186
+\calc@Adimen=\dimen139
+\calc@Bdimen=\dimen140
+\calc@Askip=\skip49
+\calc@Bskip=\skip50
+LaTeX Info: Redefining \setlength on input line 80.
+LaTeX Info: Redefining \addtolength on input line 81.
+\calc@Ccount=\count187
+\calc@Cskip=\skip51
+)
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/eso-pic/eso-pic.st
+y
+Package: eso-pic 2020/10/14 v3.0a eso-pic (RN)
+\ESO@tempdima=\dimen141
+\ESO@tempdimb=\dimen142
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/graphics/keyval.st
+y
+Package: keyval 2014/10/28 v1.15 key=value parser (DPC)
+\KV@toks@=\toks15
+)
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/xcolor/xcolor.sty
+Package: xcolor 2016/05/11 v2.12 LaTeX color extensions (UK)
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/graphics-cfg/color
+.cfg
+File: color.cfg 2016/01/02 v1.6 sample color configuration
+)
+Package xcolor Info: Driver file: pdftex.def on input line 225.
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/graphics-def/pdfte
+x.def
+File: pdftex.def 2020/10/05 v1.2a Graphics/color driver for pdftex
+)
+Package xcolor Info: Model `cmy' substituted by `cmy0' on input line 1348.
+Package xcolor Info: Model `hsb' substituted by `rgb' on input line 1352.
+Package xcolor Info: Model `RGB' extended on input line 1364.
+Package xcolor Info: Model `HTML' substituted by `rgb' on input line 1366.
+Package xcolor Info: Model `Hsb' substituted by `hsb' on input line 1367.
+Package xcolor Info: Model `tHsb' substituted by `hsb' on input line 1368.
+Package xcolor Info: Model `HSB' substituted by `hsb' on input line 1369.
+Package xcolor Info: Model `Gray' substituted by `gray' on input line 1370.
+Package xcolor Info: Model `wave' substituted by `hsb' on input line 1371.
+))
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/graphics/graphicx.
+sty
+Package: graphicx 2020/09/09 v1.2b Enhanced LaTeX Graphics (DPC,SPQR)
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/graphics/graphics.
+sty
+Package: graphics 2020/08/30 v1.4c Standard LaTeX Graphics (DPC,SPQR)
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/graphics/trig.sty
+Package: trig 2016/01/03 v1.10 sin cos tan (DPC)
+)
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/graphics-cfg/graph
+ics.cfg
+File: graphics.cfg 2016/06/04 v1.11 sample graphics configuration
+)
+Package graphics Info: Driver file: pdftex.def on input line 105.
+)
+\Gin@req@height=\dimen143
+\Gin@req@width=\dimen144
+)
+\AM@pagewidth=\dimen145
+\AM@pageheight=\dimen146
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/pdfpages/pppdftex.
+def
+File: pppdftex.def 2020/01/28 v0.5q Pdfpages driver for pdfTeX (AM)
+)
+\AM@pagebox=\box47
+\AM@global@opts=\toks16
+\AM@pagecnt=\count188
+\AM@toc@title=\toks17
+\c@AM@survey=\count189
+\AM@templatesizebox=\box48
+) (c:/Program Files/R/R-4.0.2/share/texmf/tex/latex/Sweave.sty
+Package: Sweave 
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/fancyvrb/fancyvrb.
+sty
+Package: fancyvrb 2020/05/03 v3.6 verbatim text (tvz,hv)
+\FV@CodeLineNo=\count190
+\FV@InFile=\read2
+\FV@TabBox=\box49
+\c@FancyVerbLine=\count191
+\FV@StepNumber=\count192
+\FV@OutFile=\write3
+)
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/base/textcomp.sty
+Package: textcomp 2020/02/02 v2.0n Standard LaTeX package
+) (c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/base/fontenc.sty
+Package: fontenc 2020/08/10 v2.0s Standard LaTeX package
+) (c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/ae/ae.sty
+Package: ae 2001/02/12 1.3 Almost European Computer Modern
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/base/fontenc.sty
+Package: fontenc 2020/08/10 v2.0s Standard LaTeX package
+)))
+LaTeX Font Info:    Trying to load font information for T1+aer on input line 7.
+
+ (c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/ae/t1aer.fd
+File: t1aer.fd 1997/11/16 Font definitions for T1/aer.
+)
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/l3backend/l3backen
+d-pdftex.def
+File: l3backend-pdftex.def 2020-09-24 L3 backend support: PDF output (pdfTeX)
+\l__kernel_color_stack_int=\count193
+\l__pdf_internal_box=\box50
+) (./description_of_algorithm.aux)
+\openout1 = `description_of_algorithm.aux'.
+
+LaTeX Font Info:    Checking defaults for OML/cmm/m/it on input line 7.
+LaTeX Font Info:    ... okay on input line 7.
+LaTeX Font Info:    Checking defaults for OMS/cmsy/m/n on input line 7.
+LaTeX Font Info:    ... okay on input line 7.
+LaTeX Font Info:    Checking defaults for OT1/cmr/m/n on input line 7.
+LaTeX Font Info:    ... okay on input line 7.
+LaTeX Font Info:    Checking defaults for T1/cmr/m/n on input line 7.
+LaTeX Font Info:    ... okay on input line 7.
+LaTeX Font Info:    Checking defaults for TS1/cmr/m/n on input line 7.
+LaTeX Font Info:    ... okay on input line 7.
+LaTeX Font Info:    Checking defaults for OMX/cmex/m/n on input line 7.
+LaTeX Font Info:    ... okay on input line 7.
+LaTeX Font Info:    Checking defaults for U/cmr/m/n on input line 7.
+LaTeX Font Info:    ... okay on input line 7.
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/epstopdf-pkg/epsto
+pdf-base.sty
+Package: epstopdf-base 2020-01-24 v2.11 Base part for package epstopdf
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/generic/infwarerr/infwar
+err.sty
+Package: infwarerr 2019/12/03 v1.5 Providing info/warning/error messages (HO)
+)
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/grfext/grfext.sty
+Package: grfext 2019/12/03 v1.3 Manage graphics extensions (HO)
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/generic/kvdefinekeys/kvd
+efinekeys.sty
+Package: kvdefinekeys 2019-12-19 v1.6 Define keys (HO)
+))
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/kvoptions/kvoption
+s.sty
+Package: kvoptions 2020-10-07 v3.14 Key value format for package options (HO)
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/generic/ltxcmds/ltxcmds.
+sty
+Package: ltxcmds 2020-05-10 v1.25 LaTeX kernel commands for general use (HO)
+)
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/generic/kvsetkeys/kvsetk
+eys.sty
+Package: kvsetkeys 2019/12/15 v1.18 Key value parser (HO)
+))
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/generic/pdftexcmds/pdfte
+xcmds.sty
+Package: pdftexcmds 2020-06-27 v0.33 Utility functions of pdfTeX for LuaTeX (HO
+)
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/generic/iftex/iftex.sty
+Package: iftex 2020/03/06 v1.0d TeX engine tests
+)
+Package pdftexcmds Info: \pdf@primitive is available.
+Package pdftexcmds Info: \pdf@ifprimitive is available.
+Package pdftexcmds Info: \pdfdraftmode found.
+)
+Package epstopdf-base Info: Redefining graphics rule for `.eps' on input line 4
+85.
+Package grfext Info: Graphics extension search list:
+(grfext)             [.pdf,.png,.jpg,.mps,.jpeg,.jbig2,.jb2,.PDF,.PNG,.JPG,.JPE
+G,.JBIG2,.JB2,.eps]
+(grfext)             \AppendGraphicsExtensions on input line 504.
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/latexconfig/epstop
+df-sys.cfg
+File: epstopdf-sys.cfg 2010/07/13 v1.3 Configuration of (r)epstopdf for TeX Liv
+e
+))
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/pdflscape/pdflscap
+e.sty
+Package: pdflscape 2019/12/05 v0.12 Display of landscape pages in PDF (HO)
+
+(c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/tex/latex/graphics/lscape.st
+y
+Package: lscape 2020/05/28 v3.02 Landscape Pages (DPC)
+)
+Package pdflscape Info: Auto-detected driver: pdftex on input line 81.
+) (./description_of_algorithm-concordance.tex)
+<ClustImpute_description.pdf, id=2, 597.50829pt x 845.0471pt>
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf>
+Package pdftex.def Info: ClustImpute_description.pdf  used on input line 9.
+(pdftex.def)             Requested size: 276.00105pt x 390.33818pt.
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf>
+Package pdftex.def Info: ClustImpute_description.pdf  used on input line 9.
+(pdftex.def)             Requested size: 276.00105pt x 390.33818pt.
+<ClustImpute_description.pdf, id=5, page=1, 597.50829pt x 845.0471pt>
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf, page 1>
+Package pdftex.def Info: ClustImpute_description.pdf , page1 used on input line
+ 9.
+(pdftex.def)             Requested size: 597.50682pt x 845.04504pt.
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf, page 1>
+Package pdftex.def Info: ClustImpute_description.pdf , page1 used on input line
+ 9.
+(pdftex.def)             Requested size: 597.53416pt x 845.08372pt.
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf, page 1>
+Package pdftex.def Info: ClustImpute_description.pdf , page1 used on input line
+ 9.
+(pdftex.def)             Requested size: 597.53416pt x 845.08372pt.
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf, page 1>
+Package pdftex.def Info: ClustImpute_description.pdf , page1 used on input line
+ 9.
+(pdftex.def)             Requested size: 597.53416pt x 845.08372pt.
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf, page 1>
+Package pdftex.def Info: ClustImpute_description.pdf , page1 used on input line
+ 9.
+(pdftex.def)             Requested size: 597.53416pt x 845.08372pt.
+ [1
+
+ <./ClustImpute_description.pdf{c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-va
+r/fonts/map/pdftex/updmap/pdftex.map}>]
+<ClustImpute_description.pdf, id=91, page=2, 597.50829pt x 845.0471pt>
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf, page 2>
+Package pdftex.def Info: ClustImpute_description.pdf , page2 used on input line
+ 9.
+(pdftex.def)             Requested size: 597.53416pt x 845.08372pt.
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf, page 2>
+Package pdftex.def Info: ClustImpute_description.pdf , page2 used on input line
+ 9.
+(pdftex.def)             Requested size: 597.53416pt x 845.08372pt.
+File: ClustImpute_description.pdf Graphic file (type pdf)
+<use ClustImpute_description.pdf, page 2>
+Package pdftex.def Info: ClustImpute_description.pdf , page2 used on input line
+ 9.
+(pdftex.def)             Requested size: 597.53416pt x 845.08372pt.
+ [2 <./ClustImpute_description.pdf>] (./description_of_algorithm.aux) ) 
+Here is how much of TeX's memory you used:
+ 3315 strings out of 481331
+ 51757 string characters out of 5916229
+ 322778 words of memory out of 5000000
+ 20133 multiletter control sequences out of 15000+600000
+ 405688 words of font info for 29 fonts, out of 8000000 for 9000
+ 14 hyphenation exceptions out of 8191
+ 80i,17n,85p,260b,436s stack positions out of 5000i,500n,10000p,200000b,80000s
+<c:/User
+s/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/type1/public/amsfonts/cm/cmbx1
+0.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/type1/public/ams
+fonts/cm/cmcsc10.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/t
+ype1/public/amsfonts/cm/cmr10.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf
+-dist/fonts/type1/public/amsfonts/cm/cmr7.pfb><c:/Users/opfaf/AppData/Roaming/T
+inyTeX/texmf-dist/fonts/type1/public/amsfonts/cm/cmr8.pfb><c:/Users/opfaf/AppDa
+ta/Roaming/TinyTeX/texmf-dist/fonts/type1/public/amsfonts/cm/cmti10.pfb><c:/Use
+rs/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/type1/public/lm/lmex10.pfb><c
+:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/type1/public/lm/lmmi10.p
+fb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/type1/public/lm/lmm
+i5.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/type1/public/lm
+/lmmi7.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/type1/publi
+c/lm/lmr10.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/type1/p
+ublic/lm/lmr5.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/type
+1/public/lm/lmr7.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fonts/t
+ype1/public/lm/lmsy10.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dist/fo
+nts/type1/public/lm/lmsy5.pfb><c:/Users/opfaf/AppData/Roaming/TinyTeX/texmf-dis
+t/fonts/type1/public/lm/lmsy7.pfb>
+Output written on description_of_algorithm.pdf (2 pages, 183517 bytes).
+PDF statistics:
+ 118 PDF objects out of 1000 (max. 8388607)
+ 90 compressed objects within 1 object stream
+ 0 named destinations out of 1000 (max. 500000)
+ 30 words of extra memory for PDF output out of 10000 (max. 10000000)
+

vignettes/description_of_algorithm.tex

@@ -0,0 +1,10 @@
+%\VignetteIndexEntry{Description of the algorithm}
+%\VignetteAuthor{Oliver Pfaffel}
+
+\documentclass{article}
+\usepackage{pdfpages}
+\usepackage{Sweave}
+\begin{document}
+\input{description_of_algorithm-concordance}
+\includepdf[pages=-, fitpaper=true]{ClustImpute_description.pdf}
+\end{document}