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

Easy to understand attribute names / わかりやすい属性名 #29

Open
Ningensei848 opened this issue Mar 5, 2021 · 0 comments
Open

Comments

@Ningensei848
Copy link

Ningensei848 commented Mar 5, 2021

Stanza sends a request to a public endpoint with various parameters to retrieve external data.
In the following three examples, there are different attribute names such as api, table-data-api, table_data_api, but they have in common that they are API endpoints. 🤷‍♂️

Thus, I would like all Stanza to use common vocabulary for common parts. 🖊️

On the other hand, for vocabulary specific to Stanza, I would like to see a special prefix to make it easier to recognize at a glance. (e.g. stanz-*, meta-*, mts-* , etc.) 👀


Stanza は外部のデータを取得するために様々なパラメータを持ち,公開エンドポイントを叩きに行く.

以下の三つの例では,api, table-data-api, table_data_api など属性名が異なっているが,ともに公開エンドポイントであることに変わりはない.

このように,どの Stanza においても 共通の部分は共通の語彙を使用してほしい.また,その Stanza に特有な語彙については,特別な接頭語を用いるなどしてひと目で分かるような工夫 がほしい (e.g. stanz-*, meta-*, mts-* , etc.)


Details: 詳細を見る

1. Manhattan plot

<togostanza-manhattan-plot
  api="https://db-dev.jpostdb.org/test/gwas_test.json"      <!-- api というよりは endpoint のほうが適切か? -->
  title="Manhattan plot"
  low_thresh="1"
  high_thresh="4"
  even_and_odd="false"
></togostanza-manhattan-plot>

2. table with pagination

<togostanza-table-with-pagination
  table-data-api="https://sparql-support.dbcls.jp/sparqlist/api/metastanza_table_body?taxonomy&#x3D;9606&amp;limit&#x3D;1000&amp;offset&#x3D;0&amp;count&#x3D;"  <!-- なんでここにクエリパラメータが含まれてるのか理解不能 -->
  limit="5"
  offset="0"
  params="taxonomy&#x3D;&#x27;9606&#x27;"
  page_slider="1"
  tableTitle="Title of this Table"
  columns="[{&quot;id&quot;:&quot;id&quot;,&quot;label&quot;:&quot;Accession&quot;,&quot;link&quot;:&quot;uniprot&quot;},{&quot;id&quot;:&quot;mnemonic&quot;,&quot;label&quot;:&quot;Mnemonic&quot;},{&quot;id&quot;:&quot;name&quot;,&quot;label&quot;:&quot;Proteinname&quot;},{&quot;id&quot;:&quot;mass&quot;,&quot;label&quot;:&quot;Mass&quot;,&quot;type&quot;:&quot;number&quot;},{&quot;id&quot;:&quot;location_name&quot;,&quot;label&quot;:&quot;Subcellularlocation&quot;,&quot;link&quot;:&quot;location_uniprot&quot;,&quot;rowspan&quot;:true}]"
></togostanza-table-with-pagination>

3. dev table body for pagination

<togostanza-dev-table-body
  table_data_api="https://sparql-support.dbcls.jp/rest/api/metastanza_table_example"  <!-- まさしく sparqlist の api 機能を使っているお手本のような例 -->
  limit="10"
  offset="0"
  params="taxonomy&#x3D;&#x27;9606&#x27;"
></togostanza-dev-table-body>
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

1 participant