Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publication Units (PU) #403

Closed
Tracked by #686
leothomas opened this issue Sep 28, 2021 · 3 comments
Closed
Tracked by #686

Publication Units (PU) #403

leothomas opened this issue Sep 28, 2021 · 3 comments

Comments

@leothomas
Copy link
Collaborator

Publication Units (PU) are defined as:
PU = word_count / 500 + figures_count + tables_count

Publication Units are used to determine publication cost:

< 12 PU --> Regular Fee
12 < PU < 25 --> Overage Fee
PU > 25 --> Unpublishable

Publication units should be displayed in the dashboard - I assume with some sort of colour coordination to highlight the publication fee.

I think there are 2 avenues to getting the PU into the API response for ATBDs:

  1. Dynamically calculate in LIST /atbds after filtering for the versions that the user has access to
  2. Calculate it whenever data content of the ATBD Version gets updated and store it in the AtbdVersion's data.

I suggest option 1. as an initial implementation since it won't require a background task for every single data update to the AtbdVersion

@danielfdsilva
Copy link
Collaborator

Given that counting the words is not a terribly expensive operation, it would be good to do dynamically (opt 1). This is quicker to implement and easier to maintain.

We need to clarify what elements should be checked when counting the words:

  • Do the titles of the different sections count?
  • Are the image and table captions counted as part of the table/image unit or should the words be counted?
  • Does each latex equation count as a "word" or should they be ignored.

@danielfdsilva
Copy link
Collaborator

Update from IMPACT: Because the formula is likely to change do not calculate the Publication units, but present the value for each item (words, figures, and tables)

@danielfdsilva
Copy link
Collaborator

Update from IMPACT:
Word count includes abstract, text (and in-text citations), figure captions, and appendices. Each equation counts as a word.
Word count excludes title, author list and affiliations, plain language summary, table text, references, and supporting information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants