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

Modify DOI Abstract to facilitate better abstracts being submitted #992

Open
2 tasks
maxsibilla opened this issue Oct 24, 2023 · 4 comments
Open
2 tasks
Assignees

Comments

@maxsibilla
Copy link
Contributor

maxsibilla commented Oct 24, 2023

  • Rename field in the portal to just be Abstract or something more descriptive
  • Expect a more robust description on how to fill this out to be supplied (replace the current tooltip)

Potentially

  • We could break out this one field into multiple components then splice it together in the dataset view to create a single abstract description

    • This would help define exactly what we expect the end user to provide for us
    • We could potentially update the provenance schema for Dataset to hold these distinct fields to help us do analysis later
  • We could either make this a required field

  • We could place a word minimum on this field

@maxsibilla maxsibilla self-assigned this Oct 24, 2023
@maxsibilla
Copy link
Contributor Author

Related card 915

@maxsibilla
Copy link
Contributor Author

After discussing this with @bhonick it might be useful to break out abstract into 3 distinct fields:

  • Purpose
  • Method
  • Result

This would give end users a clear a defined structure for what we expect as an abstract and having this broken out into components would allow for better mining of the abstracts. When publishing a dataset we would simply concatenate these fields to create the abstract in the DOI.

For registration purposes we would make these fields required but not put a character requirement to create a dataset. We would show a warning symbol (similar to how we handle protocol DOIs) if the field is below a certain character threshold (100 characters). We would then add a check prior to processing the dataset that all of these fields meet the character threshold. This allows data providers to quickly register datasets but forces them to enter detailed information well before publishing them.

We would also need to update the bulk registration process to:

  • Modify expected headers from "doi abstract" into these 3 fields (columns)
  • Modify the example TSV

@maxsibilla
Copy link
Contributor Author

We will need to change the existing dataset.description field to be generated similar to dataset.title

@maxsibilla
Copy link
Contributor Author

Can potentially link out to this as an example abstract: https://www.nlm.nih.gov/bsd/policy/structured_abstracts.html

Can utilize these points in the popover: https://www.nature.com/documents/nature-summary-paragraph.pdf

  • We want to add an empty text box that will show the users what the abstract will look like once all fields have been entered.

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

No branches or pull requests

1 participant