1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
% \iffalse meta-comment
%
% Copyright (C) 2020 by David Gustavsson
%
% This file may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
% version 1.3 of this license or (at your option) any later
% version. The latest version of this license is in:
%
% http://www.latex-project.org/lppl.txt
%
% and version 1.3 or later is part of all distributions of
% LaTeX version 2005/12/01 or later.
%
% \fi
%
% \iffalse
%<package>\NeedsTeXFormat{LaTeX2e}[2020/02/02]
%<package>\ProvidesPackage{datax}
%<package> [2020/11/29 v1.1.1 data import into LaTeX]
%<package>\RequirePackage{pgfkeys}
%<package>\RequirePackage{pgfopts}
%
%<*driver>
\begin{filecontents}[overwrite]{datax-example-data.tex}
\pgfkeyssetvalue{/datax/s}{A literal string}
\pgfkeyssetvalue{/datax/x}{\num{2.4}}
\pgfkeyssetvalue{/datax/c}{\SI{3e8}{\meter\per\second}}
\end{filecontents}
\begin{filecontents*}[overwrite]{datax-example-script.jl}
#!julia
using LaTeXDatax, Unitful
s = "A literal string";
x = 2.4;
c = 3e8u"m/s";
@datax s x c
\end{filecontents*}
\documentclass{ltxdoc}
\usepackage[dataxfile=datax-example-data.tex]{datax}
\usepackage{booktabs}
\usepackage{siunitx}
\usepackage[hidelinks]{hyperref}
\usepackage{tikz}
\usepackage{float}
\usepackage{listings}
\usepackage{microtype}
\newfloat{lstfloat}{htbp}{lop}
\floatname{lstfloat}{Listing}
\def\lstfloatautorefname{Listing}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}
\DocInput{datax.dtx}
\end{document}
%</driver>
% \fi
%
%\CheckSum{19}
%
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
% Digits \0\1\2\3\4\5\6\7\8\9
% Exclamation \! Double quote \" Hash (number) \#
% Dollar \$ Percent \% Ampersand \&
% Acute accent \' Left paren \( Right paren \)
% Asterisk \* Plus \+ Comma \,
% Minus \- Point \. Solidus \/
% Colon \: Semicolon \; Less than \<
% Equals \= Greater than \> Question mark \?
% Commercial at \@ Left bracket \[ Backslash \\
% Right bracket \] Circumflex \^ Underscore \_
% Grave accent \` Left brace \{ Vertical bar \|
% Right brace \} Tilde \~}
%
% \changes{v1.0}{2020/11/15}{Initial version}
% \changes{v1.1}{2020/11/17}{Polishing for release}
% \changes{v1.1.1}{2020/11/29}{Renaming the plugins, adding Python support}
%
% \GetFileInfo{datax.sty}
% \DoNotIndex{}
%
% \title{The \textsf{datax} package\thanks{This document corresponds to
% \textsf{datax}~\fileversion, dated~\filedate.}} \author{David Gustavsson
% \href{mailto:david.e.gustavsson@gmail.com}{\texttt{david.e.gustavsson@gmail.com}}}
%
% \maketitle {\centering\input{datax-logo.tikz}\\}
%
% \section{Motivation}
% \textsf{datax} allows you to export data from your scripts, and import them
% as literal strings or \textsf{siunitx} commands. If the scripts or the data
% on which they operate change, the printed data will update as well. This is
% analogous to how the author uses \textsf{graphicx} to programmatically
% generate graphics and include in a document.
%
% An alternative is to simply print |\def|s, which scales poorly (but is
% similar to how this package works under the hood). Or using something like
% \textsf{csvread}, which seems overkill for individual data points, and can be
% quite difficult to index into.
%
% \textsf{datax} is intended to work as an extension of your variable name
% space from scripts to your document: you should simply be able to call your
% variables by the same name in \LaTeX{} as in your scripts.
%
% \section{Installation}
% If you have a \LaTeX{} package manager, like texlive or miktex, use it to
% download the package from ctan. Otherwise, download the repository and place
% |datax.sty| in a place where \LaTeX{} can find it (often
% |~/texmf/tex/latex/datax/datax.sty|). Run |texhash| if needed.
%
% \section{Usage}
% The package is loaded with |\usepackage[dataxfile=|\meta{data.tex}|]{datax}|,
% which reads the file specified as \meta{dataxfile}. From then on data can be
% inserted as |\datax|\marg{tag}\DescribeMacro{\datax}. If, for instance, the
% file |data.tex| contains references to a string \(s\), a number \(x\) and a
% physical constant \(c\), then the macro produces the output in
% table~\ref{tab:outputs}.
%
% I highly recommend using \textsf{siunitx} (in general, but with
% \textsf{datax} in particular). It is of course possible to use the literal
% string function to circumvent siunitx and make \textsf{datax} print numbers
% without |\num| and |\SI|, which is why \textsf{siunitx} is not loaded as a
% prerequisite, but I have deliberately chosen to use these commands per
% default when printing numbers and quantities because it looks much better.
%
% \begin{table}
% \centering
% \caption{Outputs from the \texttt{\textbackslash{}datax}
% command}\label{tab:outputs}
% \begin{tabular}{rl}\toprule
% Input & Output \\\midrule
% |\datax{s}| & \datax{s} \\
% |\datax{x}| & \datax{x} \\
% |\datax{c}| & \datax{c} \\
% |\datax{undefined}| & \datax{undefined} \\
% \bottomrule
% \end{tabular}
% \end{table}
%
% \section{Interactions}
% Technically, \textsf{datax} only needs a data file consisting of a number of
% assignments: |\pgfkeyssetvalue{/datax/|\meta{tag}|}{|\meta{value}|}| but of
% course the entire point of the package is automation. For this, you need an
% interaction plugin for your script language. If your language is not listed
% in table~\ref{tab:plugins}, you might need to write this plugin for yourself,
% or request it.
%
% Installation instructions and usage documentation is available at the
% respective repositories. In general these plugins are installed using the
% language's default plugin manager.
%
% \begin{table}
% \centering
% \caption{Implemented language plugins}\label{tab:plugins}
% \begin{tabular}{rlp{5cm}}\toprule
% Language & Plugin & Comments\\\midrule
% |julia| & \href{https://github.com/Datax-package/LaTeXDatax.jl}{LaTeXDatax.jl} & By the present author \\
% |Matlab| & \href{https://github.com/Datax-package/LaTeXDatax.m}{LaTeXDatax.m} & By the present author \\
% |Python| & \href{https://github.com/Datax-package/LaTeXDatax.py}{LaTeXDatax.py} & By the present author \\
% \bottomrule
% \end{tabular}
% \end{table}
%
% Taking julia as an example, the variables in table~\ref{tab:outputs} could
% have been generated with the script in listing~\ref{list:julia}.
% \begin{lstfloat}
% \lstinputlisting[label=list:julia,caption={Example julia script to generate the outputs in table~\ref{tab:outputs}},
% language=python,frame=single,xleftmargin=.2\textwidth,xrightmargin=.2\textwidth]{datax-example-script.jl}
% \end{lstfloat}
%
%
% \StopEventually{\PrintIndex}
% \section{Implementation}
% Default data file name: \texttt{data.tex}
% \begin{macrocode}
\pgfkeys{ /packageoptions/dataxfile/.initial=data.tex, }
% \end{macrocode}
% Read any given options into family \texttt{/packageoptions/}. Then introduce
% family \texttt{/datax/} where all the variables will be stored.
% \begin{macrocode}
\ProcessPgfPackageOptions{/packageoptions}
\pgfkeys{ /datax/.is family, datax, %
.unknown/.code={ \pgfkeyssetvalue{ %
\pgfkeyscurrentpath/\pgfkeyscurrentname %
}{ #1 } },
}
% \end{macrocode}
% If data file exists, source it (storing all the variables in
% \texttt{/datax/}). Otherwise, throw a warning.
% \begin{macrocode}
\def\dataxfile{./\pgfkeysvalueof{/packageoptions/dataxfile}}
\InputIfFileExists{%
\dataxfile
}{}{
\PackageWarning{datax}{Cannot read file `\dataxfile'}
}
% \end{macrocode}
% \begin{macro}{\datax}
% Include datum. If the supplied tag is unused, print bold question marks (like
% |\ref|), and throw a warning.
% \begin{macrocode}
\newcommand{\datax}[1]{
\pgfkeysifdefined{/datax/#1}{ %
\pgfkeysvalueof{/datax/#1} %
}{ %
\PackageWarning{datax}{Data value `#1' undefined}\textbf{??} %
} %
}
% \end{macrocode}
% \end{macro}
% \Finale
\endinput
|
