X13AS(1)

✨ x13as β€” the X-13ARIMA-SEATS Seasonal Adjustment Program ✨

okay bestie, welcome to the x13as(1) manual page πŸ’– this is the whole thing, vibes upgraded, facts untouched. let's get into it πŸ¦‹


🌸 SYNOPSIS 🌸

x13as [args...]

πŸ’… DESCRIPTION πŸ’…

So X-13ARIMA-SEATS does the seasonal adjustment of one or several time series. that's the whole job. iconic behavior honestly πŸ‘‘

Every single argument you pass is either a filename or an option flag. and here's the cute part β€” when you hand it a filename, you do not put the extension on it, because x13as figures the extension out automatically. it just knows. main character energy fr ✨

The operations that actually get performed are described by specification files, and those have the .spc extension. their format? not documented in this manpage β€” go look at the reference manual linked down below, iykyk πŸ“„

There are three operation modes, and yes you need to know which one you're in:

  1. Operation on one series β€” the spec file goes in as the first filename. you can optionally drop a second filename for the output, but if you don't, the default is to just reuse the same basename as the spec file. alternatively? you can pass the spec file with -i and the output file with -o. both routes slay πŸŽ€
  2. Operation on multiple series, with multiple specifications β€” you give a metafile (extension .mta) as the argument of -m. that metafile holds the list of spec files, plus optionally the matching output files. very organized of it πŸ’…
  3. Operation on multiple series, with single specification β€” the spec goes in the same way as in mode one (first filename). then you hand a data metafile (extension .dta) to the -d option. that data metafile contains the list of datafiles with the .dat extension, and optionally the corresponding output files. 🫢

✨ OPTIONS ✨

  • -c β€” sums up each of the components of a composite adjustment, but only runs modeling or seasonal adjustment on the total. partial treatment, full drama πŸ’€
  • -d filename β€” filename (no extension, bestie) for the data metafile
  • -g dirname β€” the directory where the graphics metafile and the related files get stored, for feeding into external graphics programs 🎨
  • -i filename β€” filename (no extension) for the input specification file
  • -m filename β€” filename (no extension) for the input metafile
  • -n β€” no tables! only the tables you specifically asked for in the input specification file get printed out. everything else stays quiet πŸ™ˆ
  • -o filename β€” filename (no extension) used for all output files generated during this run of the program
  • -p β€” no pagination in the main output file
  • -q β€” runs X-13ARIMA-SEATS in quiet-mode, meaning warning messages do not get sent to the console 🀫
  • -r β€” produces reduced X-13ARIMA-SEATS output, same as the GiveWin version of X-13ARIMA-SEATS
  • -s β€” stores the seasonal adjustment and regARIMA model diagnostics in a file
  • -t β€” stores timing information in the diagnostics file. and heads up: if -s or -g are not specified, this will generate a diagnostic file anyway ⏱️
  • -v β€” only checks the input specification file(s) for errors, no other processing. a little vibe check, nothing more πŸ”
  • -w β€” wide (132 character) format is used in the main output file πŸ“

🌈 OUTPUT 🌈

Output files get created with the .out extension, and by default they use the basename of the specification files or the data files. 🫢

Error files may get created with the .err extension, using the same basename as the specification file. 🚨

A log file gets created with the .log extension, using the basename of either the specification file, the metafile, or the data metafile β€” which one depends on your operation mode. all three modes, all three possibilities, she's flexible like that πŸ’œ


πŸ”₯ SEE ALSO πŸ”₯

The reference manual of X-13ARIMA-SEATS is available at:

https://www2.census.gov/software/x-13arima-seats/x13as/unix-linux/documentation/docx13as.pdf

πŸ‘‘ AUTHOR πŸ‘‘

This manual page was written by Sébastien Villemot for Debian, using information from the reference manual. absolute legend for that ngl 🫢


and that's the whole page bestie!! πŸŽ€ this was the x13as(1) manual page, coming to you from the Debian x13as package β€” go adjust some seasons, you've got this πŸ’…βœ¨πŸŒ™