Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide is for new users who are interested in learning about Synapse. You will learn tutorial will guide you through fundamental Synapse features by performing some common tasks:

  • Create your own Project and add content to SynapseProvide a Project description alongside your materials via the Synapse Wiki toolsown project 

  • Upload and annotate content

  • Download a file

  • Add a description to your work

  • Share your work with other Synapse users, Teams of users teams, or the public

...

Prerequisites

Anyone can browse public content on the Synapse web site. To , but to download and create content using this tutorial, you will need to register for an account using an your email address. You will receive an email message for verification to complete the registration process.

Getting Certified

Synapse is a data sharing platform approved for storing data To upload files to Synapse, you will need to perform the additional step of becoming a Certified User. Synapse stores data from human subjects research. This , which requires special care handling and thoughtawareness. To upload files, Sage Bionetworks requires that you demonstrate awareness understanding of privacy and security issues. You can complete this your certification by taking a short Certification Quiz on Synapse.

Making and Managing Projects in Synapse

...

Creating a Project

Synapse Projects are the main “containers” where information is stored and organized in Synapse. They are online workspaces where researchers can collaborate and organize share their work with teammates. Synapse supports all kinds of working groups: Projects can be shared with individuals, small teams, and or large consortia. Projects can be private so only you can see what’s inside, or they can be shared publicly for anyone to browse.

To create a new Project:

  1. Navigate to the User Menu and click on Projectsyour Synapse Dashboard. The Projects tab should already be selected.

  2. Click the Create a New Project button.

  3. Decide on a unique name for your Project and click Save.

Your Projects dashboard stores your collection of Projects.

Read about Projects in the User Guide.

Synapse IDs

Synapse Projects are assigned a Synapse ID, a globally unique identifier used for reference with the format syn12345678. Often abbreviated to “synID”, the ID of an object never changes, even if the name does. The Synapse ID Synapse will automatically open your new project so you can view your project dashboard.

...

At the top of the page, find your project name. You can click the green star next to the project name to add it to a list of your favorites. The Synapse ID is below the project name. The Synapse ID is a unique number used as a reference in Synapse, and it is a powerful tool to identify and manage content. Often abbreviated to “synID”, these identifiers are assigned to many things in Synapse; projects, folders, files, tables, views, and wikis all have unique synIDs that can be used to navigate to and reference these specific items. The synID never changes and is always accessible in the URL and visible on the webpage.

Organizing Content in Files and Folders

Projects contain Files, which can be organized into Folders. Folders and Files the web. If you use one of the programmatic clients to interact with Synapse, you can use synIDs to create scripts that will work universally for anyone and without the need for specifying file paths.

The project dashboard also has tabs for different sections of your project:

  • Wiki -

  • Files -

  • Tables -

  • Discussion -

  • Docker -

Organizing Content

You can create folders within a project to organize your files. Files and folders also have their own unique Synapse IDs and can be moved within or between Projects. Uploaded files are stored within Synapse storage.

Use the Tools Menu to upload a file:

...

Navigate to the Files tab.

...

Use the Files Tools menu to select Add New Folder.

...

Decide on a Folder name and click Save.

...

Navigate into your new Folder and use the Folder Tools menu to select Upload or Link to a File.

...

.

To explore other features available for Files and Folders, read about annotating Filesassigning DOIsversioningProvenance, and sharing settings.

Adding a Project Wiki

...

A Wiki is a document that can be edited by multiple people on the web. Synapse uses Wikis to provide descriptions of your Project and data.

...

See the Wiki User Guide for more information and examples.

Sharing and Teams

The default setting for new Projects in Synapse is private. As a project owner, you choose who to share with, and how. You can find Project sharing settings under the Project Settings menu. Permissions or sharing settings at the Project level are automatically inherited by all Files and Folders within the Project. If needed, you can Create Local Sharing Settings to make certain Files or Folders have permissions that differ from the parent Project.

...

For more details, visit the Sharing Settings and Teams User Guide.

Sharing a Project

By default, your Project and anything inside it are private, so only you can see it. However, you can share an entire project with specific users, teams, or make it public so anyone can browse your content. If you’d like to share your Project with others, see our article on sharing and accessing data to understand how to use Synapse to control access to your data. Then, learn more about how to share an entire Project or just parts of it by reading Sharing Settings and Permissions.

Find additional information in our User Guide.

...