Versions Compared

Key

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

...

  • Add a folder to a project and upload a file

  • Annotate a file

  • Add a description to your folder with a wiki

  • Download a file

Prerequisites

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

...

Before you begin this tutorial, make sure you have already created a project (see Quick Start: Setting Up a Project /wiki/spaces/DOCS/pages/2055471258).

Uploading a File

Synapse can be used to store files of all types. All files that you upload to a project will appear in the Files tab, which is the root directory. You can also create nested folders within a Synapse project to manage files and keep them organized.

...

To learn more, see Files and Folders. To explore other features available for files and folders, read about Sharing Settings /wiki/spaces/DOCS/pages/2024276030/wiki/spaces/DOCS/pages/1972405096Versioning Files, and /wiki/spaces/DOCS/pages/1972470373.

Add a Folder Wiki

You can add a description to the folder you just created by adding a folder wiki. Wikis can be added to projects, folders, tables, and files in Synapse, and they can help you communicate essential details, instructions, or other information about your work to other collaborators.

...

Your wiki content will be visible to anyone who has access to your folder.

To learn more, see the Wikis /wiki/spaces/DOCS/pages/1975746682 article.

Annotating Files

Annotations help you find files and search for data, and they are an essential component of the FAIR principles for data management. In Synapse, annotations are stored as key-value pairs, where the key defines a particular aspect of your data (for example, species, assay, file format) and the value defines a variable that belongs to that category (mouse, RNAseq, .bam). You can add annotations to projects, files, folders, tables, and views in Synapse. In this example, you will annotate the file that you uploaded in the previous section of this tutorial:

...

For more information, see the Annotations and Queries article.

Downloading Files

You can download files from the Synapse web interface or use one of the programmatic clients. If you are downloading files from the web, you can either download single files at once, or you can add multiple files to a download list, which is similar to an online shopping cart. On the web, the maximum size of a download is 5 GB, or a maximum of 100 files if using the download list. To download larger files in greater numbers, we recommend using one of the programmatic clients /wiki/spaces/DOCS/pages/1985446128.

Before you can download a file from Synapse, you must determine whether you have access to it. Click on a file name and look for a green or yellow lock symbol. A green unlock symbol means that the file is available for you to download. A yellow locked symbol means that the file is not available to you. Contact the project owner or click Request Access. To learn more about data access, see Sharing and Accessing Data /wiki/spaces/DOCS/pages/2014904611.

...

To download a file from the web:

...

See Getting Started with Synapse API Clients to install your preferred API client. For more instructions on how to download data from Synapse programmatically, visit the docs for Python, R, or command line.

Files and Folders, Annotations and Queries, Sharing Settings /wiki/spaces/DOCS/pages/2024276030Versioning Files, and /wiki/spaces/DOCS/pages/1972470373

...