CTAN
Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/dataref

README.md

dataref

Writ­ing sci­en­tific texts is a craft. It is the craft of com­mu­ni­cat­ing your re­sults to your col­leagues and to the cu­ri­ous world pub­lic. Often your con­clu­sions are based upon facts and num­bers that you gath­ered dur­ing your re­search for the spe­cific topic. You might have done many ex­per­i­ments and pro­duced lot of data. The craft of writ­ing is to guide your reader through a nar­ra­tive that is based upon that data. But there may be many ver­sions of that data. Per­haps you found a prob­lem in your ex­per­i­ment, while al­ready writ­ing, that forces you back into the lab­o­ra­tory. After a while, the moon has done its cir­cle many times, you re­turn from that dark place and your method­ol­ogy has im­proved as sig­nif­i­cantly as your data has. But now you have to rewrite that parts of the data, that ref­er­ence the old data points. The dataref is here to help you with man­ag­ing your data points. It pro­vides you with macro style keys, that rep­re­sent sym­bolic names for your dat­ap­ints. You can ref­er­ence those sym­bolic names with dref, use them in cal­cu­la­tions to have al­ways up-to-date per­cent­age val­ues, de­fine pro­jec­tions be­tween sets of data points and doc­u­ment them. dataref also in­tro­duces the no­tion of as­ser­tions (drefassert) for your re­sults to en­sure that your prosa text ref­er­ences fit the un­der­ly­ing data.

Build­ing the doc­u­men­ta­tion

With la­texmk in­stalled:

make

or

pdflatex dataref.tex; pdflatex dataref.tex; pdflatex dataref.tex

Ex­am­ples

Set­ting sym­bolic data points

\drefset{/count}{42}
\drefset{/abc}{23}

Ref­er­enc­ing them with dref, dref­calc, drefassert

\dref{/count}  => 42
\drefcalc{data("/abc") / data("/count")} => 0.55
\drefassert{data("/abc") < data("/count")}

Get­ting the lat­est ver­sion

dataref is hosted at github: https://github.com/stet­tberger/dataref

Down­load the con­tents of this pack­age in one zip archive (247.2k).

dataref – Man­age ref­er­ences to ex­per­i­men­tal data

The pack­age pro­vides a mech­a­nism that main­tains a fixed sym­bolic ref­er­ence to nu­mer­i­cal re­sults; such re­sults may vary as the project pro­ceeds (and hence the project re­port de­vel­ops).

Pack­agedataref
Home pagehttps://github.com/stet­tberger/dataref
Ver­sion0.6 2017-01-06
Li­cense The Project Public Li­cense 1.3
Copy­right2013–2017 Chris­tian Di­et­rich
Main­tainerChris­tian Di­et­rich
Con­tained inTeX Live as dataref
MiKTeX as dataref
Topics ma­nip­u­late data within
la­bel and ref­er­ence sys­tems
...
Guest Book Sitemap Contact Contact Author