pub-analyzer 0.4.3__py3-none-any.whl → 0.5.1__py3-none-any.whl

pub_analyzer/internal/templates/author/report.typ

@@ -1,91 +0,0 @@
-// This document was generated using Pub Analyzer version {{ version }}.
-//
-// Pub Analyzer is a tool designed to retrieve, process and present in a concise and understandable
-// way the scientific production of a researcher, including detailed information about their articles,
-// citations, collaborations and other relevant metrics.
-//
-// See more here: https://pub-analyzer.com
-
-// Packages
-//
-// This document uses the Cetz package to render plots and graphs. For more information
-// on how to edit the plots see: https://typst.app/universe/package/cetz/
-
-#import "@preview/cetz:0.2.2": canvas, plot, chart, palette
-
-// Colors
-//
-// The following variables control all colors used in the document.
-// You can modify the color codes by specifying the four RGB(A) components or by
-// using the hexadecimal code.
-//
-// See more here: https://typst.app/docs/reference/visualize/color/#definitions-rgb
-
-#let SUCCESS = rgb("#909d63")
-#let ERROR   = rgb("#bc5653")
-
-#let CATEGORY_1 = rgb("#42a2f8")
-#let CATEGORY_2 = rgb("#82d452")
-#let CATEGORY_3 = rgb("#929292")
-#let CATEGORY_4 = rgb("#f0bb40")
-#let CATEGORY_5 = rgb("#eb4025")
-#let CATEGORY_6 = rgb("#c33375")
-
-#let PALETTE = (CATEGORY_1, CATEGORY_2, CATEGORY_3, CATEGORY_4, CATEGORY_5, CATEGORY_6)
-
-// Page Layout
-#set page("us-letter")
-#set page(flipped: true)
-
-#set heading(numbering: "1.")
-#set page(footer: grid(
-    columns: (1fr, 1fr),
-    align(left)[Made with #link("https://pub-analyzer.com")[_pub-analyzer_] version {{ version }}],
-    align(right)[#counter(page).display("1")],
-  )
-)
-
-// Text config
-#set text(size: 10pt)
-#set par(justify: true)
-
-// Override reference
-#show ref: it => {
-  let el = it.element
-  if el != none and el.func() == heading {
-    // Override heading references.
-    numbering(
-      el.numbering,
-      ..counter(heading).at(el.location())
-    )
-  } else {
-    // Other references as usual.
-    it
-  }
-}
-
-// Title
-#grid(
-  columns: (1fr),
-  row-gutter: 11pt,
-
-  [#align(center, text(size: 17pt, weight: "bold")[{{ report.author.display_name }}])],
-  {% if report.author.last_known_institutions %}
-  {% set last_known_institution = report.author.last_known_institutions[0] %}
-  [#align(center, text(size: 15pt, weight: "thin")[{{ last_known_institution.display_name }}])],
-  {% endif %}
-)
-
-{% include 'author_summary.typ' %}
-
-{% include 'works.typ' %}
-
-{% include 'works_extended.typ' %}
-
-{% include 'sources.typ' %}
-
-#pagebreak()
-
-= Bibliography
-
-Priem, J., Piwowar, H., & Orr, R. (2022). OpenAlex: A fully-open index of scholarly works, authors, venues, institutions, and concepts. ArXiv. https://arxiv.org/abs/2205.01833

pub_analyzer/internal/templates/author/sources.typ

@@ -1,22 +0,0 @@
-// Sources
-= Sources.
-
-#table(
-  columns: (auto, 3fr, 2fr, auto, auto, auto, auto, auto),
-  inset: 8pt,
-  align: horizon,
-  // Headers
-  [], [*Name*], [*Publisher or institution*], [*Type*], [*ISSN-L*], [*Impact factor*], [*h-index*], [*Is OA*],
-
-  // Content
-  {% for source in report.sources_summary.sources %}
-  [3.{{ loop.index }}. #label("source_{{ source.id.path.rpartition("/")[2] }}")],
-  [#underline([#link("{{ source.homepage_url }}")[#"{{ source.display_name }}"]])],
-  [{{ source.host_organization_name or "-" }}],
-  [{{source.type }}],
-  [{{ source.issn_l or "-" }}],
-  [{{ source.summary_stats.two_yr_mean_citedness|round(3) }}],
-  [{{ source.summary_stats.h_index }}],
-  [{% if source.is_oa %}#text(rgb(SUCCESS))[True]{% else %}#text(rgb(ERROR))[False]{% endif %}],
-  {% endfor %}
-)

pub_analyzer/internal/templates/author/works.typ

@@ -1,154 +0,0 @@
-// Works
-= Works.
-
-#let works_metrics_card(title: "Title", graph, body) = {
-  grid(
-    rows: (18pt, 175pt, 60pt),
-    columns: 100%,
-
-    [
-      #block(width: 100%, height: 100%)[
-        #align(center + horizon)[#text(style: "italic")[#title]]
-      ]
-    ],
-    [
-      #block(width: 100%, height: 100%)[
-        #align(center + horizon)[#graph]
-      ]
-    ],
-    [
-      #block(width: 100%, height: 100%, inset: (x: 0pt, y: 10pt))[#body]
-    ],
-  )
-}
-
-#grid(
-  columns: (1fr, 1fr, 1fr),
-  column-gutter: 15pt,
-  [
-    #let graph = {
-      canvas(length: 35%, {
-        chart.piechart(
-          (
-            {{ report.citation_summary.type_a_count }}, // Type A
-            {{ report.citation_summary.type_b_count }}  // Type B
-          ),
-          radius: 1,
-          slice-style: (PALETTE.at(0), PALETTE.at(1)),
-          outer-label: (content: "%", radius: 115%),
-        )
-      })
-    }
-
-    #works_metrics_card(title: "Citation metrics", graph)[
-      #grid(
-        rows: auto, row-gutter: 10pt,
-        columns: (1fr, 1fr),
-
-        grid.cell(colspan: 2)[
-          *Count:* {{ report.citation_summary.type_a_count + report.citation_summary.type_b_count }}
-        ],
-        [#box(height: 7pt, width: 7pt, fill: PALETTE.at(0)) *Type A:* {{ report.citation_summary.type_a_count }}],
-        [#box(height: 7pt, width: 7pt, fill: PALETTE.at(1)) *Type B:* {{ report.citation_summary.type_b_count }}],
-      )
-    ]
-  ],
-  [
-    #let graph = {
-      canvas(length: 35%, {
-        chart.columnchart(
-          size: (2.45, 2.0),
-          y-grid: false,
-          bar-style: palette.new(
-            base: (stroke: none, fill: none),
-            colors: PALETTE
-          ),
-          (
-            {% for work_type in report.works_type_summary[:4] %}
-            ("{{ work_type.type_name[:2]|capitalize }}", {{ work_type.count }}),
-            {% endfor %}
-          )
-        )
-      })
-    }
-    #works_metrics_card(title: "Work Type", graph)[
-      #grid(
-        rows: auto, row-gutter: 10pt,
-        columns: (1fr, 1fr),
-        column-gutter: 5pt,
-
-        grid.cell(colspan: 2)[
-          *Count:* {{ report.open_access_summary.model_dump().items()|sum(attribute="1") }}
-        ],
-
-        {% for work_type in report.works_type_summary[:4] %}
-        [
-          #box(height: 7pt, width: 7pt, fill: PALETTE.at({{ loop.index0 }})) *{{ work_type.type_name|capitalize }}:* {{ work_type.count }}
-        ],
-        {% endfor %}
-      )
-    ]
-  ],
-  [
-    #let graph = {
-      canvas(length: 35%, {
-        chart.piechart(
-          (
-            {{report.open_access_summary.diamond}},   // diamond
-            {{report.open_access_summary.gold}},      // Gold
-            {{report.open_access_summary.green}},     // Green
-            {{report.open_access_summary.hybrid}},    // Hybrid
-            {{report.open_access_summary.bronze}},    // Bronze
-            {{report.open_access_summary.closed}},    // Closed
-          ),
-          radius: 1,
-          inner-radius: .4,
-          slice-style: (PALETTE.at(0), PALETTE.at(3), PALETTE.at(1), PALETTE.at(4), PALETTE.at(5), PALETTE.at(2)),
-          outer-label: (content: "%", radius: 115%),
-        )
-      })
-    }
-    #works_metrics_card(title: "Open Access", graph)[
-      #grid(
-        rows: auto, row-gutter: 10pt,
-        columns: (1fr, 1fr, 1fr),
-        column-gutter: 5pt,
-
-        grid.cell(colspan: 3)[
-          *Count:* {{ report.open_access_summary.model_dump().items()|sum(attribute="1") }}
-        ],
-
-        [#box(height: 7pt, width: 7pt, fill: PALETTE.at(0)) *Diamond:* {{report.open_access_summary.diamond}}],
-        [#box(height: 7pt, width: 7pt, fill: PALETTE.at(3)) *Gold:* {{report.open_access_summary.gold}}],
-        [#box(height: 7pt, width: 7pt, fill: PALETTE.at(1)) *Green:* {{report.open_access_summary.green}}],
-        [#box(height: 7pt, width: 7pt, fill: PALETTE.at(5)) *Bronze:* {{report.open_access_summary.bronze}}],
-        [#box(height: 7pt, width: 7pt, fill: PALETTE.at(2)) *Closed:* {{report.open_access_summary.closed}}],
-        [#box(height: 7pt, width: 7pt, fill: PALETTE.at(4)) *Hybrid:* {{report.open_access_summary.hybrid}}],
-      )
-    ]
-  ],
-)
-
-#align(center, text(11pt)[Works from {{ report.works[0].work.publication_year }} to {{ report.works[-1].work.publication_year }}])
-#table(
-  columns: (auto, 3fr, auto, auto, auto, auto, auto, auto, auto),
-  inset: 8pt,
-  align: horizon,
-  // Headers
-  [], [*Title*], [*Type*], [*DOI*], [*Publication Date*], [*Cited by count*], [*Type A*], [*Type B*], [*OA*],
-
-  // Content
-  {% for work in report.works %}
-  [#underline([#link(label("work_{{ loop.index }}"))[@work_{{ loop.index }}]])],
-  [#"{{ work.work.title.replace('"', '\\"') }}"],
-  [{{ work.work.type }}],
-  [{% if work.work.ids.doi %}#underline([#link("{{ work.work.ids.doi }}")[DOI]]){% else %}-{% endif %}],
-  [{{ work.work.publication_date }}],
-  [{{ work.citation_summary.type_a_count + work.citation_summary.type_b_count }}],
-  [{{ work.citation_summary.type_a_count }}],
-  [{{ work.citation_summary.type_b_count }}],
-  [{{ work.work.open_access.oa_status.value }}],
-
-  {% endfor %}
-)
-#pagebreak()

pub_analyzer/internal/templates/author/works_extended.typ

@@ -1,109 +0,0 @@
-{% for work in report.works %}
-
-{% if not loop.first %}
-#pagebreak()
-{% endif %}
-
-== #text()[#"{{ work.work.title.replace('"', '\\"') }}"] <work_{{ loop.index }}>
-
-#linebreak()
-
-{% if work.work.abstract %}
-#text()[#"{{ work.work.abstract.replace('"', '\\"')|truncate(1000) }}"]
-
-#linebreak()
-
-{% endif %}
-
-// Cards
-#grid(
-  columns: (1fr, 1fr, 1fr),
-  column-gutter: 30pt,
-  [
-    #align(center)[_Authorships_]
-    #parbreak()
-    {% for authorship in work.work.authorships[:10] %}
-    - *{{ authorship.author_position }}:* #underline([#link("{{ authorship.author.orcid or authorship.author.id }}")[#text({% if authorship.author.display_name == report.author.display_name %}rgb(SUCCESS){% endif %})[{{ authorship.author.display_name }}]]])
-    {% endfor %}
-    {% if work.work.authorships|length > 10 %}
-    - *...*
-    {% endif %}
-  ],
-  [
-    #align(center)[_Open Access_]
-    #parbreak()
-    - *Status:* {{ work.work.open_access.oa_status.value }}
-    {% if work.work.open_access.oa_url %}- *URL:* #underline([#link("{{ work.work.open_access.oa_url }}")[{{ work.work.open_access.oa_url }}]]){% endif %}
-  ],
-  [
-    #align(center)[_Citation_]
-    #parbreak()
-    - *Count:* {{ work.citation_summary.type_a_count + work.citation_summary.type_b_count }}
-    - *Type A:* {{ work.citation_summary.type_a_count }}
-    - *Type B:* {{ work.citation_summary.type_b_count }}
-  ],
-)
-
-#linebreak()
-
-// Cited by Table
-{% if work.cited_by %}
-#align(center, text(11pt)[_Cited by_])
-#table(
-  columns: (auto, 3fr, auto, auto, auto, auto, auto),
-  inset: 8pt,
-  align: horizon,
-  // Headers
-  [], [*Title*], [*Type*], [*DOI*], [*Cite Type*], [*Publication Date*], [*Cited by count*],
-
-  // Content
-  {% for cited_by_work in work.cited_by %}
-  [{{ loop.index }}],
-  [#"{{ cited_by_work.work.title.replace('"', '\\"') }}"],
-  [{{ cited_by_work.work.type }}],
-  [{% if cited_by_work.work.ids.doi %}#underline([#link("{{ cited_by_work.work.ids.doi }}")[DOI]]){% else %}-{% endif %}],
-  [{% if cited_by_work.citation_type.value == 0 %}#text(rgb(SUCCESS))[Type A]{% else %}#text(rgb(ERROR))[Type B]{% endif %}],
-  [{{ cited_by_work.work.publication_date }}],
-  [{{ cited_by_work.work.cited_by_count }}],
-  {% endfor %}
-)
-{% endif %}
-
-// Sources Table
-{% if work.work.locations %}
-#align(center, text(11pt)[_Sources_])
-#table(
-  columns: (auto, 3fr, 2fr, auto, auto, auto, auto, auto),
-  inset: 8pt,
-  align: horizon,
-  // Headers
-  [], [*Name*], [*Publisher or institution*], [*Type*], [*ISSN-L*], [*Is OA*], [*License*], [*Version*],
-
-  // Content
-  {% for location in work.work.locations %}
-  {% if location.source %}
-  [#underline([#link(label("source_{{ location.source.id.path.rpartition("/")[2] }}"))[{{ loop.index }}]])],
-  [#underline([#link("{{ location.landing_page_url }}")[#"{{ location.source.display_name }}"]])],
-  [{{ location.source.host_organization_name or "-" }}],
-  [{{ location.source.type }}],
-  [{{ location.source.issn_l or "-" }}],
-  [{% if location.is_oa %}#text(rgb(SUCCESS))[True]{% else %}#text(rgb(ERROR))[False]{% endif %}],
-  [{{ location.license or "-" }}],
-  [{{ location.version.name or "-" }}],
-  {% else %}
-  [{{ loop.index }}],
-  [#underline([#link("{{ location.landing_page_url }}")[#"{{ location.landing_page_url }}"]])],
-  [-],
-  [-],
-  [-],
-  [{% if location.is_oa %}#text(rgb(SUCCESS))[True]{% else %}#text(rgb(ERROR))[False]{% endif %}],
-  [{{ location.license or "-" }}],
-  [{{ location.version.name or "-" }}],
-  {% endif %}
-  {% endfor %}
-)
-{% endif %}
-
-{% endfor %}
-
-#pagebreak()