Document toolboxDocument toolbox

Tools Schema

Some of these fields have Synapse annotations defined: https://github.com/Sage-Bionetworks/synapseAnnotations/blob/master/synapseAnnotations/data/tool.json

Field NameDescriptionSynonymsColumn TypeFacet (Y/N)Required (Y/N)DestinationNotesApplies to Which Tool Type
toolName
name, methodNamestringNYlinkname is a clickable link, URL sourced from "link" columncomputational, experimental, clinical
description
summarylarge textNY

computational, experimental, clinical
linklink to access the toollinkURLNY

computational, experimental, clinical
consortiumKey for mappingorganization, program, fundingAgencystringYN

computational, experimental, clinical
grantKey for mappingprojectstringYN

computational, experimental, clinical
studyKey for mapping
stringYN

computational, experimental, clinical
contributorcontributor namecontactstringNN

computational, experimental, clinical
contributorContactsynID or email address
entity? email?NN

computational, experimental, clinical
toolTypee.g. bench science/experimental, computational, or clinical
stringYN
also associated with different icons?
computational, experimental, clinical
subTypemouse model, cell line, R shiny tool, etc
stringYN
***is this needed?

reagentTypemouse model, cell line, viral vector
stringYN

experimental
softwareType
type of Software, e.g. script, packageLibrary, container, graphical user interface, web user interface, web application

stringYN

computational
softwareLanguagesoftware language e.g. R, python, matlab
stringYN

computational
inputDataTypesource data for tool e.g. geneExpression, proteomics
stringYN

computational
outputDataTypeoutput data of tool e.g. genomicVariants, image, proteomics
stringYN

computational
diagnosise.g. Late onset AD, Familial ADtumor typestringYN

computational, experimental, clinical
modelTypee.g. APP mouse model, Trem2 model
stringYN

experimental
outputDatasetsdatasets generated using this tool or about this tool
entityNN
is this data using the tool or about the tool? ie rnaseq data from a workflow tool vs rnaseq data ON a mouse model
computational, experimental, clinical
publicationslist of publications?
large textNN
what is the expected display and behavior?
computational, experimental, clinical
controlledAccess

booleanNN

computational, experimental, clinical
documentationlink to wiki or PDF containing documentation, possibly in Synapse
URLNN

computational, experimental, clinical
featured

booleanNN

computational, experimental, clinical