Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Correcting links to the python docs pages

...

Creating a Project

To create a new project:

  1. Click the Projects icon in the left-hand toolbar, and click the plus sign (+) icon next to Projects

    • (Alternatively, you can go to your dashboard and click Create a New Project

  2. Enter a unique name for your Project and click OK

Files

Synapse files can be created by uploading content from your local computer or linking to digital files on the web. You can /wiki/spaces/DOCS/pages/2667708522, /wiki/spaces/DOCS/pages/2667774092, or /wiki/spaces/DOCS/pages/1972405096

...

You can control who has access to files that you upload in two ways. First, you can apply sharing settings, which control who can view, edit, download, or delete a file. Second, you can also apply conditions for use, which are additional requirements that Synapse users must meet before accessing your file. By default, files inherit the conditions for use of the Synapse folder where they are uploaded. You can also add additional conditions for use on specific files within a folder.

...

Creating a Folder

To create a folder:

  1. Within your Synapse project, click the Files tab

  2. To create a folder at this level*, click the Files Tools menu, followed by Add New Folder

  3. Enter a folder name and click Save

*To create a folder within a folder, click on the folder name within the project, and click the Folder Tools menu, followed by Add New Folder, and proceed to step 3.

Uploading a File via the Synapse UI

To upload a file:

  1. Within your Synapse project, click the Files tab

  2. Click the Files Tools menu (or, to upload a file to a folder, then first go to the folder, and click the Folder Tools menu), followed by Upload or Link to a File

  3. Click Browse to select the file, or drag and drop it to upload, or click Link to URL to add a link to an external storage space

  4. Click Save

Uploading a File Programmatically

(plus) You can annotate your data during the upload process or after. Find more information here.

Command line

The command line has the sub-command store, which can be used to upload and add a file to Synapse.

...

The main function for uploading or updating a file in the Python client is through the store function. For more information about this function, see the Python Docs.

Code Block
import synapseclient
from synapseclient import File
syn = synapseclient.login()

# Add a local file to an existing project (syn12345) on Synapse
file = File(path='/path/to/raw_data.txt', parent='syn12345')
file = syn.store(file)


...

To move a file or folder:

  1. Within the file or folder, click File Tools or Folder Tools, followed by Move File or Move Folder

  2. In the resulting pop-up window, browse for the destination folder or project or use the search bar to enter the Synapse ID of the new location

Moving a File or Folder Programmatically

...

Deleting a file will permanently remove it from Synapse. The synID that was associated with the deleted file will not be re-used. To delete a file:

  1. Within the project, click the Files tab

  2. Click the file or folder you want to delete (or the file/folder within a folder)

  3. Click File Tools or Folder Tools, followed by Delete File or Delete Folder

Deleting a File or Folder Programmatically

...

To see a file preview, navigate to the Files tab of a project and click on the file name. If a file preview is available, it will be visible in the left window.

Deleting a Project

Deleting a project will permanently remove it from Synapse. The synID that was associated with the deleted project will not be re-used. To delete a project:

  1. Navigate to the project you want to delete

  2. Within the project, click the Project Tools button

  3. Click Delete Project

  4. In the dialog box, click the red Delete button to permanently delete the project, or click Cancel if you do not want to delete the project