Skip to content

Commit

Permalink
Change outline structure for scoping section under db-2.0.qmd.
Browse files Browse the repository at this point in the history
  • Loading branch information
rogilmore committed Aug 6, 2024
1 parent dc4753a commit 4a75ee6
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 17 deletions.
27 changes: 17 additions & 10 deletions docs/more-information/db-2.0.html
Original file line number Diff line number Diff line change
Expand Up @@ -398,11 +398,14 @@ <h2 id="toc-title">Table of contents</h2>
</ul></li>
<li><a href="#scoping" id="toc-scoping" class="nav-link" data-scroll-target="#scoping">Scoping</a>
<ul>
<li><a href="#databrary-2.0-rewrite" id="toc-databrary-2.0-rewrite" class="nav-link" data-scroll-target="#databrary-2.0-rewrite">Databrary 2.0 rewrite</a>
<ul class="collapse">
<li><a href="#file-uploadsdownloads" id="toc-file-uploadsdownloads" class="nav-link" data-scroll-target="#file-uploadsdownloads">File uploads/downloads</a></li>
<li><a href="#spreadsheet" id="toc-spreadsheet" class="nav-link" data-scroll-target="#spreadsheet">Spreadsheet</a></li>
<li><a href="#security" id="toc-security" class="nav-link" data-scroll-target="#security">Security</a></li>
<li><a href="#adminsuperuser" id="toc-adminsuperuser" class="nav-link" data-scroll-target="#adminsuperuser">Admin/Superuser</a></li>
<li><a href="#access-to-volumes" id="toc-access-to-volumes" class="nav-link" data-scroll-target="#access-to-volumes">Access to volumes</a></li>
</ul></li>
<li><a href="#roadmap-2.0" id="toc-roadmap-2.0" class="nav-link" data-scroll-target="#roadmap-2.0">Roadmap (&gt;2.0)</a>
<ul class="collapse">
<li><a href="#support-for-open-data-schemas" id="toc-support-for-open-data-schemas" class="nav-link" data-scroll-target="#support-for-open-data-schemas">Support for open data schemas</a></li>
Expand Down Expand Up @@ -730,45 +733,49 @@ <h3 class="anchored" data-anchor-id="sessions-interface">Sessions interface</h3>
</section>
<section id="scoping" class="level2">
<h2 class="anchored" data-anchor-id="scoping">Scoping</h2>
<section id="databrary-2.0-rewrite" class="level3">
<h3 class="anchored" data-anchor-id="databrary-2.0-rewrite">Databrary 2.0 rewrite</h3>
<p>While the core of Databrary 1.0 is understood and will be replicated in Databrary 2.0, some questions will be explored that relate to new features:</p>
<section id="file-uploadsdownloads" class="level3">
<h3 class="anchored" data-anchor-id="file-uploadsdownloads">File uploads/downloads</h3>
<section id="file-uploadsdownloads" class="level4">
<h4 class="anchored" data-anchor-id="file-uploadsdownloads">File uploads/downloads</h4>
<ul>
<li>(<span class="discuss-feature">discuss</span>): Should video and audio transcoding be automatic or optional; if optional, how can transcoding be triggered?
<ul>
<li>Should transcoding be “premium” service?</li>
</ul></li>
</ul>
</section>
<section id="spreadsheet" class="level3">
<h3 class="anchored" data-anchor-id="spreadsheet">Spreadsheet</h3>
<section id="spreadsheet" class="level4">
<h4 class="anchored" data-anchor-id="spreadsheet">Spreadsheet</h4>
<ul>
<li>(<span class="discuss-feature">discuss</span>): (What features of the existing session/slot spreadsheet interface for managing and visualizing demographic data can be implemented easily and at minimal cost using existing libraries?</li>
</ul>
<p>See also <a href="../more-information/db-2.0.html#support-for-open-data-schemas">below</a> section on support for schemas.</p>
</section>
<section id="security" class="level3">
<h3 class="anchored" data-anchor-id="security">Security</h3>
<section id="security" class="level4">
<h4 class="anchored" data-anchor-id="security">Security</h4>
<ul>
<li><del>Can two-factor authentication be added? If so, at what cost?</del><a href="#fn3" class="footnote-ref" id="fnref3" role="doc-noteref"><sup>3</sup></a></li>
</ul>
</section>
<section id="adminsuperuser" class="level3">
<h3 class="anchored" data-anchor-id="adminsuperuser">Admin/Superuser</h3>
<section id="adminsuperuser" class="level4">
<h4 class="anchored" data-anchor-id="adminsuperuser">Admin/Superuser</h4>
<ul>
<li>(<span class="discuss-feature">discuss</span>): Can per-institution (across users and projects), per-user (across projects) or per-project storage quotas be implemented? Can warnings be generated when storage amounts are nearing quotas? How could Super Users manage user requests to increase quotas?</li>
<li>(<span class="discuss-feature">discuss</span>): Can a more informative administrative console be developed with by-volume, usage, and storage metrics, including shared vs.&nbsp;unshared data? If so, at what cost?</li>
</ul>
<p>See also section <a href="../more-information/db-2.0.html#administrative-upgrades">below</a> about other administrative upgrades. This will probably get pushed to later.</p>
</section>
<section id="access-to-volumes" class="level3">
<h3 class="anchored" data-anchor-id="access-to-volumes">Access to volumes</h3>
<section id="access-to-volumes" class="level4">
<h4 class="anchored" data-anchor-id="access-to-volumes">Access to volumes</h4>
<ul>
<li>(<span class="discuss-feature">discuss</span>): Volume access expires after a user-defined date that is no longer than one year from the date of the last update.</li>
</ul>
</section>
</section>
<section id="roadmap-2.0" class="level3">
<h3 class="anchored" data-anchor-id="roadmap-2.0">Roadmap (&gt;2.0)</h3>
<p>These ideas are on the longer-term roadmap.</p>
<section id="support-for-open-data-schemas" class="level4">
<h4 class="anchored" data-anchor-id="support-for-open-data-schemas">Support for open data schemas</h4>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -1449,7 +1449,7 @@
"href": "more-information/db-2.0.html#scoping",
"title": "Databrary 2.0",
"section": "Scoping",
"text": "Scoping\nWhile the core of Databrary 1.0 is understood and will be replicated in Databrary 2.0, some questions will be explored that relate to new features:\n\nFile uploads/downloads\n\n(discuss): Should video and audio transcoding be automatic or optional; if optional, how can transcoding be triggered?\n\nShould transcoding be “premium” service?\n\n\n\n\nSpreadsheet\n\n(discuss): (What features of the existing session/slot spreadsheet interface for managing and visualizing demographic data can be implemented easily and at minimal cost using existing libraries?\n\nSee also below section on support for schemas.\n\n\nSecurity\n\nCan two-factor authentication be added? If so, at what cost?3\n\n\n\nAdmin/Superuser\n\n(discuss): Can per-institution (across users and projects), per-user (across projects) or per-project storage quotas be implemented? Can warnings be generated when storage amounts are nearing quotas? How could Super Users manage user requests to increase quotas?\n(discuss): Can a more informative administrative console be developed with by-volume, usage, and storage metrics, including shared vs. unshared data? If so, at what cost?\n\nSee also section below about other administrative upgrades. This will probably get pushed to later.\n\n\nAccess to volumes\n\n(discuss): Volume access expires after a user-defined date that is no longer than one year from the date of the last update.\n\n\n\nRoadmap (&gt;2.0)\n\nSupport for open data schemas\n\nDatabrary should eventually support standard schemas wherever practical, specifically in the JSON-LD format. These should use Schema.org properties.\nExamples of properties that seem relevant to Databrary include:\n\nPerson\nCreative Work\n\nVideoObject\n\nEvent\n\nFor a data collection session or change in status on the site.\n\nPlace\n\nTesting locations, geographical information, locations of institutions\n\nData Types\n\n\n\n\n\n\n\n\nNote\n\n\n\nThese examples are not exhaustive.\n\n\nDatabrary should also support NIH Common Data Elements (CDEs), especially for “spreadsheet” data elements.\n\nExamples of CDE properties of a Person\n\nGender: https://cde.nlm.nih.gov/formView?tinyId=vx35JcbgJI\nSex at Birth: https://cde.nlm.nih.gov/deView?tinyId=rGEh0ckdmr\nRace: https://cde.nlm.nih.gov/deView?tinyId=Fakc6Jy2x\nRace/Ethnicity Self-Identification: https://cde.nlm.nih.gov/deView?tinyId=LakF0YkywC\nEthnicity: https://cde.nlm.nih.gov/deView?tinyId=PtRlg7yLP_\nDisabilities: https://cde.nlm.nih.gov/deView?tinyId=0md12WGtZXE\nBirth date: https://cde.nlm.nih.gov/deView?tinyId=X1mJv5j3jx.\n\n\n\n\n\n\n\n\nNote\n\n\n\nThere are a set of CDEs that NIH endorses. These should be the highest priority.\n\n\n\n\nImproved search and filtering\nIdeas from HNDS-I 2024 proposal:\n\nBroader set of demographic characteristics.\nIndex other text documents in materials folders.\n\n\nIndex annotation files, return segments\n\n“Building on this foundation, we will upgrade Databrary to support searching within annotation files linked to videos that tag specific behaviors, utterances, or contexts, starting with the most popular annotation file formats stored on Databrary (Datavyu and CHAT)”\n\n— HNDS-I proposal.\n\n\n\n“Virtual volumes” or custom collections\n\nTo capitalize on enhanced search and filtering and ease data reuse, users must be able to create their own custom collections of video files, video segments, annotations, and other data derived from multiple, primary datasets. The custom collections or “virtual datasets” will link to but not copy parent datasets and their associated metadata.\n\n— HNDS-I proposal.\n\n\nWorkspaces\n\n…We will implement private, flexible, temporary workspaces for datasets that act like folders in cloud storage. Unlike other forms of cloud storage that provide only a temporary home for research data, Databrary’s workspaces will provide a permanent and flexible home that is just a button press away from being made accessible to the broader research community.\n\n– HNDS-I proposal.\n\n\nExpanding scriptable access\n\n…We will build on the free, open-source, R package, databraryr, that PI Gilmore developed with NSF support and openly released to the research community. Databraryr wraps Databrary API calls into commands that are useful to researchers who want to download shared data from Databrary. We will add data uploading capabilities to the R package to support Aim 3, develop and publish a parallel Python package, databrarypy.\n\n– HNDS-I proposal.\n\n\nAdministrative upgrades\n\nQuotas on per-user, per-institution storage footprints.\nInfrastructure for managing subscriptions, curation assistance, data deposit fees.\nLinks to institutional admin panel functions; data footprint, etc.\n\n\n\nVersion control\nZenodo and OSF implement this.\n\n\nPrivate volumes for peer review\nOSF implements this.",
"text": "Scoping\n\nDatabrary 2.0 rewrite\nWhile the core of Databrary 1.0 is understood and will be replicated in Databrary 2.0, some questions will be explored that relate to new features:\n\nFile uploads/downloads\n\n(discuss): Should video and audio transcoding be automatic or optional; if optional, how can transcoding be triggered?\n\nShould transcoding be “premium” service?\n\n\n\n\nSpreadsheet\n\n(discuss): (What features of the existing session/slot spreadsheet interface for managing and visualizing demographic data can be implemented easily and at minimal cost using existing libraries?\n\nSee also below section on support for schemas.\n\n\nSecurity\n\nCan two-factor authentication be added? If so, at what cost?3\n\n\n\nAdmin/Superuser\n\n(discuss): Can per-institution (across users and projects), per-user (across projects) or per-project storage quotas be implemented? Can warnings be generated when storage amounts are nearing quotas? How could Super Users manage user requests to increase quotas?\n(discuss): Can a more informative administrative console be developed with by-volume, usage, and storage metrics, including shared vs. unshared data? If so, at what cost?\n\nSee also section below about other administrative upgrades. This will probably get pushed to later.\n\n\nAccess to volumes\n\n(discuss): Volume access expires after a user-defined date that is no longer than one year from the date of the last update.\n\n\n\n\nRoadmap (&gt;2.0)\nThese ideas are on the longer-term roadmap.\n\nSupport for open data schemas\n\nDatabrary should eventually support standard schemas wherever practical, specifically in the JSON-LD format. These should use Schema.org properties.\nExamples of properties that seem relevant to Databrary include:\n\nPerson\nCreative Work\n\nVideoObject\n\nEvent\n\nFor a data collection session or change in status on the site.\n\nPlace\n\nTesting locations, geographical information, locations of institutions\n\nData Types\n\n\n\n\n\n\n\n\nNote\n\n\n\nThese examples are not exhaustive.\n\n\nDatabrary should also support NIH Common Data Elements (CDEs), especially for “spreadsheet” data elements.\n\nExamples of CDE properties of a Person\n\nGender: https://cde.nlm.nih.gov/formView?tinyId=vx35JcbgJI\nSex at Birth: https://cde.nlm.nih.gov/deView?tinyId=rGEh0ckdmr\nRace: https://cde.nlm.nih.gov/deView?tinyId=Fakc6Jy2x\nRace/Ethnicity Self-Identification: https://cde.nlm.nih.gov/deView?tinyId=LakF0YkywC\nEthnicity: https://cde.nlm.nih.gov/deView?tinyId=PtRlg7yLP_\nDisabilities: https://cde.nlm.nih.gov/deView?tinyId=0md12WGtZXE\nBirth date: https://cde.nlm.nih.gov/deView?tinyId=X1mJv5j3jx.\n\n\n\n\n\n\n\n\nNote\n\n\n\nThere are a set of CDEs that NIH endorses. These should be the highest priority.\n\n\n\n\nImproved search and filtering\nIdeas from HNDS-I 2024 proposal:\n\nBroader set of demographic characteristics.\nIndex other text documents in materials folders.\n\n\nIndex annotation files, return segments\n\n“Building on this foundation, we will upgrade Databrary to support searching within annotation files linked to videos that tag specific behaviors, utterances, or contexts, starting with the most popular annotation file formats stored on Databrary (Datavyu and CHAT)”\n\n— HNDS-I proposal.\n\n\n\n“Virtual volumes” or custom collections\n\nTo capitalize on enhanced search and filtering and ease data reuse, users must be able to create their own custom collections of video files, video segments, annotations, and other data derived from multiple, primary datasets. The custom collections or “virtual datasets” will link to but not copy parent datasets and their associated metadata.\n\n— HNDS-I proposal.\n\n\nWorkspaces\n\n…We will implement private, flexible, temporary workspaces for datasets that act like folders in cloud storage. Unlike other forms of cloud storage that provide only a temporary home for research data, Databrary’s workspaces will provide a permanent and flexible home that is just a button press away from being made accessible to the broader research community.\n\n– HNDS-I proposal.\n\n\nExpanding scriptable access\n\n…We will build on the free, open-source, R package, databraryr, that PI Gilmore developed with NSF support and openly released to the research community. Databraryr wraps Databrary API calls into commands that are useful to researchers who want to download shared data from Databrary. We will add data uploading capabilities to the R package to support Aim 3, develop and publish a parallel Python package, databrarypy.\n\n– HNDS-I proposal.\n\n\nAdministrative upgrades\n\nQuotas on per-user, per-institution storage footprints.\nInfrastructure for managing subscriptions, curation assistance, data deposit fees.\nLinks to institutional admin panel functions; data footprint, etc.\n\n\n\nVersion control\nZenodo and OSF implement this.\n\n\nPrivate volumes for peer review\nOSF implements this.",
"crumbs": [
"More information",
"Databrary 2.0"
Expand Down
2 changes: 1 addition & 1 deletion src/.quarto/cites/index.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"appendices/access_agreement.qmd":[],"appendices/sharing-release-staff.qmd":[],"appendices/grants.qmd":[],"background/ethics.qmd":[],"for-affiliates/requesting-access-affiliates.qmd":[],"for-affiliates/onboarding-affiliates.qmd":[],"for-investigators/background.qmd":[],"for-affiliates/creating-new-volume-affiliates.qmd":[],"for-affiliates/reusing-data-affiliates.qmd":[],"more-information/references.qmd":["Gilmore2017-wd"],"appendices/participant_info.qmd":[],"appendices/terms.qmd":[],"for-investigators/onboarding.qmd":[],"appendices/irb-application-template.qmd":[],"for-investigators/determine-status.qmd":[],"for-investigators/data-sharing.qmd":[],"index.qmd":["Soska2021-mh","Adolph_KE_Gilmore_RO_Kennedy_JL2017-va","Gilmore2017-wd","Gilmore2017-wd"],"appendices/sharing-release-script.qmd":[],"appendices/sharing-release-participants.qmd":[],"background/who-why.qmd":[],"for-affiliates/background.qmd":[],"more-information/faq.qmd":[],"for-investigators/managing-people.qmd":[],"for-investigators/requesting-access.qmd":[],"for-investigators/edit-existing-volume.qmd":[],"more-information/db-2.0.qmd":[],"background/determine-status.qmd":[],"more-information/more-information.qmd":[],"appendices/privacy_policy.qmd":[],"for-investigators/reusing-data.qmd":[],"appendices/post-visit-release-email.qmd":[],"for-investigators/create-new-volume.qmd":[],"for-investigators/best-practices.qmd":[],"for-affiliates/Affiliates-Intro.qmd":[],"more-information/software.qmd":[],"for-institutions/background.qmd":[],"for-affiliates/edit-existing-volume-affiliates.qmd":[],"more-information/definitions.qmd":[],"for-affiliates/affiliates-intro.qmd":[],"background/introduction.qmd":[]}
{"more-information/faq.qmd":[],"appendices/sharing-release-participants.qmd":[],"more-information/more-information.qmd":[],"for-investigators/reusing-data.qmd":[],"more-information/db-2.0.qmd":[],"appendices/access_agreement.qmd":[],"for-affiliates/requesting-access-affiliates.qmd":[],"for-affiliates/onboarding-affiliates.qmd":[],"background/determine-status.qmd":[],"for-investigators/determine-status.qmd":[],"appendices/sharing-release-staff.qmd":[],"for-investigators/onboarding.qmd":[],"appendices/post-visit-release-email.qmd":[],"for-investigators/create-new-volume.qmd":[],"for-institutions/background.qmd":[],"more-information/definitions.qmd":[],"for-affiliates/reusing-data-affiliates.qmd":[],"for-affiliates/affiliates-intro.qmd":[],"more-information/software.qmd":[],"background/introduction.qmd":[],"appendices/participant_info.qmd":[],"for-affiliates/edit-existing-volume-affiliates.qmd":[],"appendices/sharing-release-script.qmd":[],"for-investigators/best-practices.qmd":[],"for-affiliates/creating-new-volume-affiliates.qmd":[],"appendices/privacy_policy.qmd":[],"appendices/terms.qmd":[],"for-investigators/managing-people.qmd":[],"index.qmd":["Soska2021-mh","Adolph_KE_Gilmore_RO_Kennedy_JL2017-va","Gilmore2017-wd","Gilmore2017-wd"],"more-information/references.qmd":["Gilmore2017-wd"],"for-investigators/background.qmd":[],"for-investigators/data-sharing.qmd":[],"background/ethics.qmd":[],"appendices/irb-application-template.qmd":[],"for-affiliates/background.qmd":[],"for-affiliates/Affiliates-Intro.qmd":[],"background/who-why.qmd":[],"for-investigators/edit-existing-volume.qmd":[],"for-investigators/requesting-access.qmd":[],"appendices/grants.qmd":[]}
Loading

0 comments on commit 4a75ee6

Please sign in to comment.