IQSS / IQSS/dataverse-client-javascript

Extend GetCollectionItems use case: add show_relevance

オープン
#464 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

GREI Re-arch SPA
主要言語
TypeScript
スター
20
フォーク
11
平均マージ
2日 5時間
マージ済み PR(30日)
1

説明

In the Collections page, when a term is entered in the search bar, the collection items should show snippets with the search term highlighted. To do this, we need to update GetCollectionItems to call the Dataverse search api with show_relevance=true.

For example, when searching for 'King' in Dataverse, the snippets of metadata that contain king are shown, and for the description field, 'King' is highlighted.
In the JSF, we are only highlighting the search term in the description, but using the API we could also highlight the term in other metadata.

The API for this example:
https://dataverse.harvard.edu/api/v1/search?show_relevance=true&q=king&show_facets=true&sort=score&order=desc&subtree=harvard&per_page=10&type=dataverse&type=dataset&type=file

In the response, the matches array contains the snippets to be displayed:

{
  "status": "OK",
  "data": {
    "q": "king",
    "total_count": 3019,
    "start": 0,
    "spelling_alternatives": {

    },
    "items": [
      {
        "name": "Replication data for: Empirical vs. Theoretical Claims about Extreme Counterfactuals: A Response",
        "type": "dataset",
        "url": "https://doi.org/10.7910/DVN/VL7QMO",
        "image_url": "https://dataverse.harvard.edu/api/datasets/53129/logo",
        "global_id": "doi:10.7910/DVN/VL7QMO",
        "description": "A response to Sambanis and Michaelides, \"A Comment on Diagnostic Tools for Counterfactual Inference\", which was a comment on: Gary King and Langche Zeng. 2006. \" The Dangers of Extreme Counterfactuals,\" Political Analysis, 14, 2, Pp. 131-159. In response to the data-based measures of model dependence proposed in King and Zeng (2006), Sambanis and Michaelides (2008) propose alternative measures that rely upon assumptions untestable in observational data. If these assumptions are correct, then their measures are appropriate and ours, based solely on the empirical data, may be too conser vative. If instead and as is usually the case, the researcher is not certain of the precise functional form of the data generating process, the distribution from whic h the data are drawn, and the applicability of these modeling assumptions to new counterfactuals, then the data-based measures proposed in King and Zeng (2006) are much preferred. After all, the point of model dependence checks is to verify empirically, rather than to stipulate by assumption, the effects of modeling assumptions on counterfactual inferences.",
        "published_at": "2014-08-07T00:00:00Z",
        "publisher": "Gary King Dataverse",
        "citationHtml": "King, Gary; Zeng, Langche, 2009, \"Replication data for: Empirical vs. Theoretical Claims about Extreme Counterfactuals: A Response\", \u003Ca href=\"https://doi.org/10.7910/DVN/VL7QMO\" target=\"_blank\"\u003Ehttps://doi.org/10.7910/DVN/VL7QMO\u003C/a\u003E, Harvard Dataverse, V5",
        "identifier_of_dataverse": "king",
        "name_of_dataverse": "Gary King Dataverse",
        "citation": "King, Gary; Zeng, Langche, 2009, \"Replication data for: Empirical vs. Theoretical Claims about Extreme Counterfactuals: A Response\", https://doi.org/10.7910/DVN/VL7QMO, Harvard Dataverse, V5",
        "matches": [
          {
            "dsDescriptionValue": {
              "snippets": [
                "A response to Sambanis and Michaelides, \"A Comment on Diagnostic Tools for Counterfactual Inference\", which was a comment on: Gary \u003Cspan class=\"search-term-match\"\u003EKing\u003C/span\u003E and Langche Zeng. 2006. \" The Dangers of Extreme Counterfactuals,\" Political Analysis, 14, 2, Pp. 131-159. In response to the data-based measures of model dependence proposed in \u003Cspan class=\"search-term-match\"\u003EKing\u003C/span\u003E and Zeng (2006), Sambanis and Michaelides (2008) propose alternative measures that rely upon assumptions untestable in observational data. "
              ]
            }
          },
          {
            "publicationCitation": {
              "snippets": [
                "\u003Cspan class=\"search-term-match\"\u003EKing\u003C/span\u003E, Gary, and Langche Zeng. 2009. Empirical versus Theoretical Claims about Extreme Counterfactuals: A Response. Political Analysis 17: 107-112: Link to article"
              ]
            }
          },
          {
            "authorName": {
              "snippets": [
                "\u003Cspan class=\"search-term-match\"\u003EKing\u003C/span\u003E, Gary"
              ]
            }
          }
        ],
        "score": 7039.38525390625,
        "publicationStatuses": [
          "Published"
        ],
        "storageIdentifier": "s3://1902.1/11903",
        "subjects": [
          ""
        ],
        "fileCount": 13,
        "versionId": 428465,
        "versionState": "RELEASED",
        "majorVersion": 5,
        "minorVersion": 2,
        "createdAt": "2008-09-06T16:35:54Z",
        "updatedAt": "2024-09-20T15:10:46Z",
        "contacts": [
          {
            "name": "",
            "affiliation": ""
          }
        ],
        "publications": [
          {
            "citation": "King, Gary, and Langche Zeng. 2009. Empirical versus Theoretical Claims about Extreme Counterfactuals: A Response. Political Analysis 17: 107-112: \u003Ca href=\"http://j.mp/pr0WRJ\" target=\"_blank\" rel=\"nofollow\"\u003ELink to article\u003C/a\u003E"
          }
        ],
        "authors": [
          "King, Gary",
          "Zeng, Langche"
        ]
      },
Image

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

GetCollectionItems ユースケースから始めて、Collections ページが Dataverse の検索リクエストをどのように構築し、結果をどのように表示するかを追跡します。検索語が入力されたときにリクエストに show_relevance=true が含まれていることを確認し、続いてレスポンスの matches 配列のスニペットがメタデータフィールド内で該当する語をハイライトして表示されることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
frontend
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
66/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。