Versions Compared

Key

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

...

Although a dataset is similar to a file view /wiki/spaces/DOCS/pages/2011070739, it serves different purposes. While a file view allows you to set a scope for a folder that could be continuously updating, a dataset includes specific versions of files that you determine when setting it up.

After creating a dataset, it will exist as a draft version, meaning you can continue editing it as you wish. You can also create a stable (static) version of the dataset at that point in time, which cannot be changed. You can share this stable version with others, or link it to a publication, by minting a DOI /wiki/spaces/DOCS/pages/1972405096.

Since you can create and share a dataset with files you do not own, it’s important to ensure that you follow the Synapse Terms and Conditions of Use.

When to use a dataset vs. a file view

As mentioned, a dataset is similar to a file view /wiki/spaces/DOCS/pages/2011070739 in that its purpose is to group a specific set of files together, there are distinct differences between the two, which may determine when you would use one over the other. Review the table below for a summary of these differences.

...

Note

Notice the banner indicating that this is a draft version of the dataset. A draft dataset should not be distributed externally until it is finalized by creating a stable version. See the section Create a Stable Version below for more information.

Add files to the dataset

  1. In the dataset, click Add Items

  2. In the Add Files to Dataset window, browse for the file(s) you want to add

    1. Click on the name of a project to see all folders, files, and tables contained within that project. Note that only files can be selected and added to the dataset

    2. If you want to see the contents of an individual folders, click the dropdown arrow next to a project name, or next to a folder, to reveal all of its contents. This will allow you to select in individual files contained within

    3. You can also search for individual files using the Search for Files tool (Note that you cannot use this tool to search for folders or projects, only individual files)

  3. Click the checkbox next to any of the file(s) that you want to add. If you want to add all files from within a folder, you can click the general checkbox at the top of the list to add all contents. You can also select which version of the file you want to appear in your dataset.

    (plus) Find more information at Versioning Tables, Views, and Datasets /wiki/spaces/DOCS/pages/2667675758.

    Your selections will appear in the Selected box at the bottom. They will remain in this “selected” status, even as you navigate through other folders and files. You can remove individual selections from here if necessary.

  4. Once you have selected all of the files you want, click Add Files. All files from your Selected box will be added to the dataset. At this point, before saving the dataset, you can still add or remove files from the dataset, or change the version of any files (see screenshot below)

  5. Click Save to save your current selection and return to the draft dataset

In the screenshot below, notice how there are several actions you can take after adding new files, before saving this version. You can use the checkmarks to select any of the files and remove them, or use the Version dropdowns to change the version selection of any file. You can also add new files. Note that you can also edit the draft dataset after saving, but if you create a stable version then it will reflect the selection that you included at the time of creation. See the section Create a Stable Version below for more information on this.

...

How to use a dataset

Once you have created a draft dataset, there are a number of things you can do to it, similar to other features in Synapse. This includes:

...

In the dataset, click on Dataset Tools, and select Dataset Sharing Settings from the dropdown menu. This will show you the current sharing settings of the dataset. Note that sharing settings of the dataset will be inherited from any parent projects or folders. If you want to have different settings on a specific file, you can create local sharing settings and then modify them. See this article for more information

(plus) For more information on sharing settings, see /wiki/spaces/DOCS/pages/2024276030.

Annotate the dataset with metadata

...

(plus) Find more information and instructions at Digital Object Identifiers (DOIs).