createsummary(1)

💖 createsummary(1) — the manual, but make it make sense 💖

okay bestie, welcome to the General Commands Manual for createsummary. this is the Scalar File Summarization Tool and she is lowkey iconic. let's get into it ✨

---

🌸 NAME 🌸

createsummary — Scalar File Summarization Tool

---

🎀 SYNOPSIS 🎀

createsummary [Var Names] -batch -interactive -compress=Level
              -ignore-scalar-file-errors

---

🦋 DESCRIPTION 🦋

okay so createsummary is a summarization tool for scalar files, and what she does is literally create one GNU R data table file for each scalar. she ate that fr fr. CreateSummary also supports on-the-fly BZip2 compression, which is giving efficiency 💅.

here's the part you NEED to know though: after startup, the program accepts the following commands from standard input — and that is not as command-line arguments! i said what i said. stdin only. periodt.

• --varnames=Variables — a space-separated list of output variable names to be added to the output data tables. 🫶
• --values=Values — sets the values of the output variables for the next scalar file to the provided space-separated values. one value for each variable has to be provided, so don't be shy with them. one per variable. no more, no less 💀
• --logfile=Name — sets the log file for the next scalar file. on an error related to this scalar file, the log file's name is displayed. you can use this option to identify bad simulation/measurement runs by pointing to the log file being created for the simulation/measurement. it's giving detective energy 🔍
• --statusfile=Name — sets the status file for the next scalar file. on an error related to this scalar file, the status file is deleted. you can use this option to repeat bad simulation/measurement runs by re-running the simulation/measurement on missing status files. honestly? clever. she's tracking the vibes ✨
• --input=Filename — process the given scalar file. simple as that, no notes 💖
• --skip=Prefix — all scalars beginning with the given prefix are not written to output tables. this option can be used to filter out unneeded results. we love a filter queen 🎀
• --simulationdirectory=Directory — sets the directory where to find the scalar files. like, where they live 🏠
• --resultsdirectory=Directory — sets the directory where to write the summary tables to. the output destination, the final boss location 📍
• --ignore-scalar-file-errors — Ignore skalar file erros (that is, missing input files) instead of aborting. yes, the original says "skalar file erros" and i am respecting the lore, no cap 🙈

---

⭐ ARGUMENTS ⭐

The following arguments may be provided:

• Var Names — A space-separated list of output variable names to be added to the output data tables.
• -batch — Run in batch mode. The program is aborted on errors. she does NOT play about batch mode 😭
• -interactive — Run in interactive mode. On errors, the program is continued. chill vibes only, she keeps going 🫶
• -compress=0-9 — Sets the BZip2 compression level; 1=none, 9=highest (default). so 9 is the default because she likes to go all out, obviously 👑
• -ignore-scalar-file-errors — Ignore skalar file erros (that is, missing input files) instead of aborting.

---

🌈 EXAMPLE 🌈

Consider two simulation results test1.sca.bz2 (created with ParameterX=One) and test2.sca.bz2 (created with ParameterX=Two). The scalar files are located in the current directory, the output tables should be written to /tmp with compression level 5:

( echo "--simulationsdirectory=."  && \
  echo "--resultsdirectory=/tmp"   && \
  echo "--values=One"              && \
  echo "--input=test1.sca.bz2"     && \
  echo "--values=Two"              && \
  echo "--input=test2.sca.bz2" ) | createsummary "ParameterX"
-compress=5

like look at her go. piping all those echoes straight into createsummary with "ParameterX" as the variable name. main character energy, fr fr 💅

---

👑 AUTHORS 👑

Thomas Dreibholz

https://www.nntb.no/~dreibh/netperfmeter

mailto://thomas.dreibholz@gmail.com

---

shoutout to the author, we love and respect them 🫶

---

and that's the whole page bestie, no skips, no summaries, every flag accounted for 💖

CreateSummary · October 1, 2014 · createsummary(1)

that's a wrap, iykyk ✨🎀🦋💜