This guide is for new users who are interested in learning about Synapse. You will learn fundamental Synapse features by performing some common tasks:
Synapse is an open source collaborative platform. It can store data, code, results, and descriptions research work. Synapse hosts many research projects and resources. It also hosts crowdsourced competitions, including DREAM Challenges. Sage Bionetworks provides Synapse services free of charge to the scientific community through generous support from various funding sources.
Anyone can browse public content on the Synapse web site, but to download and create content you will need to register for an account using an email address. You will receive an email message for verification to complete the registration process.
Synapse can store human subject data with sharing and use restrictions. Before you can upload files, you must demonstrate you understand what you can share in Synape. To start this process:
Read the accounts, certification, and profile validation page to learn more about the different levels of users.
Synapse content is organized in
Projects. In a project you can upload files and write descriptions (Wikis). Each Project also contains a discussion forum.
To create a
Projectand click Save.
By default, your newly created
Project is private. You are the only person who can access it, including any content in it. In another tutorial you will learn how to share your project with other users.
Synapse projects are assigned a Synapse ID, unique identifiers used for reference with the format
To find your project at any time, you can see your projects on your dashboard.
You can use the
Files tab to upload data, code, results, and other information to your project. Synapse Folders are used to organize content and can contain other Folders and Files. Synapse
Files are also assigned a unique identifier (Synapse ID).
To add a
To upload a file into that folder:
A Wiki is a document that can be edited by multiple people on the web. The Wiki tab in a project provides a space to write a description. This Wiki can be organized with subpages and a table of contents. Folders and files in your project can also have a wiki. You can use the wiki to document the contents of the folder or file, similar to a README.
Wiki pages are written with Markdown, a lightweight syntax for styling text on the web. In addition to standard Markdown,
Wiki pages can contain customized content, including images, tables, code blocks, LaTeX formatted equations, and scholarly references. Synapse Wiki widgets also allow you to embed content based on other resources stored in Synapse.
See the Wiki user guide for more information and examples.
Create a Project wiki:
To add a wiki to a folder or file:
By default, access to folders and files is controlled by the same sharing settings as the project. You may set different sharing settings for specific folders and files in a project.
You may share a
Project with specific people or make it public.
For more details, read the How to Share Projects section of the Sharing Settings and Conditions for Use instructions.
For instructions on changing sharing settings for
Files, read the Sharing Other Content section of the Sharing Settings and Conditions for Use instructions.
Find additional information in our User Guide.