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

How to handle attributes that are "not available" ? #82

Closed
joncison opened this issue Jun 15, 2017 · 6 comments
Closed

How to handle attributes that are "not available" ? #82

joncison opened this issue Jun 15, 2017 · 6 comments

Comments

@joncison
Copy link
Member

joncison commented Jun 15, 2017

i.e. to support mooted information standard for bio.tools, based on biotoolsSchema.

The proposal is

  • for attributes with enums, add "Not available" to the enum
  • for publications, input, output, links and downloads, add a boolean to the corresponding types (<publication>, <input>, <output>, <link> and download) e.g. "NotAvailable" which can be set true

I think this is better than a purely generic approach, e.g. simply adding a boolean for all attributes (which I think would bloat the schema / serialisation formats unnecessarily)

Thoughts? cc @ekry

@hansioan
Copy link
Member

I think at least one of "Not available" or "Not applicable" should apply to all the attributes marked with * (star). In this way we know they have been inspected and marked correspondingly , either with an annotation or with "Not available" / "Not applicable".

@joncison
Copy link
Member Author

Absolutely

@joncison
Copy link
Member Author

joncison commented Nov 2, 2017

this done gracefully in biotools_dev.xsd for doi, pmid and pmcid elements under publication (simply "Not available" was added to the regex of these elements). cc @hansioan

joncison pushed a commit that referenced this issue Nov 2, 2017
implements #69, #73  and partially implements #82
@joncison
Copy link
Member Author

joncison commented Nov 4, 2017

For `license' I added "Unlicensed" to the enum.

"Not available" on DOI etc changed to "Unpublished" which is more explicit thus more useful.

@joncison
Copy link
Member Author

joncison commented Nov 4, 2017

urlftpType simple type (as used by link->url, download-url and documentation->url) regex extended with "Not available" (as required by the bio.tools information standard (https://github.com/bio-tools/biotoolsSchemaDocs/blob/master/information_requirement.rst).

With the other changes (above) this nails, from the schema perspective, the issue of "Not available" in the information standard (#77, https://github.com/bio-tools/biotoolsSchemaDocs/blob/master/information_requirement.rst)

@joncison
Copy link
Member Author

footnote cc @hansioan we'll soon have an "applicability matrix" of attributes in the standard (more precisely, biotoolsSchema elements) vs. tool types, which can be used when computing stats on compliance to the standards

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

No branches or pull requests

2 participants