General question aboout literate statistical practice pipeline

Hüsing, Johannes via ESS-help <[email protected]> Mon, 3 Feb 2025 09:05:15 +0000
Newsgroups gmane.emacs.ess.general
Message-ID <[email protected]>
--===============6127833749305669947==
Content-Type: text/plain; charset="UTF-8"
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
Content-length: 3036

Dear all,
glad to notice that this list has become a bit more lively. I hope I won't =
derail the ongoing discussions by posing another, rather general question. =
The aim of literate programming seems to be to work on code and its documen=
tation in parallel. One technique to achive this is to keep code and its do=
cumentation in close proximity.
In literal statistical practice (LSP), the results of the statistical analy=
sis becomes another part of the output. The output is normally a side effec=
t of running the program, while in classical literate programming the code =
needn't necessarily be executed in the tangling process. The term LSP, intr=
oduced by Anthony Rossini, did not quite catch on but the principle is simi=
lar
When I produce an analysis in the form of an LSP document, I tend to strugg=
le with the arrangements of function definitions, which are normally docume=
nted for the underlying assumptions for my choice of model, and running the=
 functions, which produces automatically generated documentation. When I ke=
ep definition and execution separated, the definition parts remain silent b=
ecause nothing is "happening" yet. The narrative of what I am doing and why=
 tends to fall apart.
One could say that putting the analysis into a package would solve my probl=
em, because the functions will be documented in separate *.Rd files while t=
he actual analysis can be put into a vignette. This would address my proble=
m but at the cost of the overhead that package productions brings with it (=
even if I steer clear of devtools::check()).
Am I the only one around here or did anyone else encounter this problem? Wh=
at is your generic pipeline for analyses done where methods are not run-of-=
the-mill?

Hope I could get my problem across.

Best

Johannes

PS sorry for any unrelated content my employer tacks to the end of this mai=
l.

Dr. Johannes H=FCsing
Epidemiologie

Landeskrebsregister NRW gGmbH
Gesundheitscampus 10
44801 Bochum



T 0234 54509-216
F 0234 54509-499
[email protected]<mailto:Johannes.Huesing@krebsregister=
.nrw.de>
www.landeskrebsregister.nrw<http://www.landeskrebsregister.nrw>

Das Landeskrebsregister NRW online
FACEBOOK: https://www.facebook.com/LKRNordrheinWestfalen/
INSTAGRAM: https://www.instagram.com/landeskrebsregister_nrw
LINKEDIN: https://www.linkedin.com/company/87452209/admin/feed/posts/

Newsletter LKR NRW - jetzt anmelden unter
 https://www.landeskrebsregister.nrw/aktuelles/newsletter




Gesch=E4ftsf=FChrer
Dr. Andres Sch=FCtzend=FCbel
Vorsitzender der Gesellschafterversammlung
Staatssekret=E4r Matthias Heidmeier
Sitz der Gesellschaft
Bochum
Registergericht
Amtsgericht Bochum
HRB 17715

HINWEIS: Diese Nachricht ist nur f=FCr den Adressaten bestimmt. Es ist nich=
t erlaubt, diese Nachricht zu kopieren oder Dritten zug=E4nglich zu machen.=
 Sollten Sie irrt=FCmlich diese Nachricht erhalten haben, bitte ich um Ihre=
 Mitteilung per E-Mail oder unter der oben angegebenen Telefonnummer.

	[[alternative HTML version deleted]]


--===============6127833749305669947==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

______________________________________________
[email protected] mailing list
https://stat.ethz.ch/mailman/listinfo/ess-help

--===============6127833749305669947==--