COUNTERPROC(1p)

πŸ’– COUNTERPROC(1p) πŸ’–

okay so bestie, this is the manual page for counterproc, part of the User Contributed Perl Documentation family. it's giving "i process COUNTER reports and i do it gorgeously." let's get into it ✨


🌸 NAME 🌸

counterproc β€” process a COUNTER report. that's it, that's the whole job, and she does it flawlessly πŸ’…


✨ SYNOPSIS ✨

counterproc [option...] [file...]

counterproc -h|--help

counterproc -V|--version

πŸ¦‹ DESCRIPTION πŸ¦‹

so counterproc does all the common little tasks you'd want to do on electronic resource reports that conform (more or less, bestie, we're being honest here) to the COUNTER Codes of Practice, Release 2. that includes:

  • report validation βœ…
  • correcting a bunch of common errors πŸ”§
  • extracting raw usage data πŸ“Š

the action you want is specified as an option, and the file you want processed is the sole non-option argument. no file? no problem β€” standard input gets processed instead. iconic.

about the output, because this part matters:

  • the (corrected) report goes to standard output
  • whatever other output is appropriate for the action you picked goes to standard error

so don't get it twisted, they're on different streams. πŸ‘‘


πŸ’€ DIAGNOSTICS πŸ’€

the exit status of counterproc will be 0 if the report is valid, or -1 if the report is not valid. that's the whole vibe check. fr fr.


πŸŽ€ OPTIONS πŸŽ€

ok so real talk: if none of -c, --validate, -A, or --atomize is specified, the report gets processed using Biblio::COUNTER::Processor::Simple, which prints verbose diagnostic information to standard error and the (corrected) report to standard output. just so you know what you're walking into. πŸ’–
  • -c, --validate β€” Validate the input.

Biblio::COUNTER::Processor::Validate will be used to check the report, printing a count of errors and warnings to standard error and the (corrected) output to standard output. it's giving "here's what's wrong with your report, no filter." 🫢

  • -A, --atomize β€” Extract data from the report, producing a single tab-delimited line for each datum. the data lines are preceded by a single line containing column headers. πŸ“Š

each line of output has the following elements, which appear in the order listed:

  • code β€” The short code that indicates the type of the report (e.g., "JR1" or "DB3").
  • file β€” The name of the file containing the report. Set to "-" if processing standard input.
  • processor β€” The <Biblio::COUNTER::Processor::Atomize|Biblio::COUNTER::Processor::Atomize> instance. (Just ignore this.)
  • report β€” The instance of the appropriate subclass of <Biblio::COUNTER::Report|Biblio::COUNTER::Report>. (Ignore this, too.)
  • period β€” A string of the form YYYY-mm denoting the period in question.
  • metric β€” The type of event counted ("requests", "sessions", "searches", or "turnaways").
  • count β€” The count itself.
  • platform β€” The platform on which the resource was provided.
  • title β€” The resource title.
  • publisher β€” The resource's publisher. May be the empty string.
  • print_issn (journal reports only) β€” The journal's print ISSN.
  • online_issn (journal reports only) β€” The journal's online ISSN.
  • isbn (book reports only) β€” The book's ISBN.
  • -v, --verbose β€” Be verbose. The effect of this depends on the action to be taken. (mysterious, we love that for her ✨)
  • -h, --help β€” Print help information and exit. πŸ†˜
  • -V, --version β€” Print the version number and exit. If the -v or --verbose option is specified, print out additional information. πŸ”
  • -M, --manual β€” View the manual page for counterproc. πŸ“–
  • -L, --license β€” View the license under which counterproc is distributed. πŸ“œ

πŸ‘‘ AUTHOR πŸ‘‘

Paul Hoffman (nkuitse AT nkuitse DOT com)


Copyright 2008-2009 Paul M. Hoffman.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl:

  1. the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version;

or

  1. the "Artistic License".

For the full text of these licenses, see the script file itself or enter the command counterproc -L.


🧚 SEE ALSO 🧚

  • Biblio::COUNTER
  • Biblio::COUNTER::Report
  • Biblio::COUNTER::Report::Processor::Simple
  • Biblio::COUNTER::Report::Processor::Validate
  • Biblio::COUNTER::Report::Processor::Atomize

and that's the whole page bestie πŸ’– this one's running on perl v5.36.0 and it's dated 2023-02-04, so go forth and process those reports, you absolute main character. mwah πŸŽ€βœ¨

πŸ“¦ where this page comes from