In this step, you will create a LabKey Study folder and set some basic study properties. Study folders contain tools to help you manage your study, organize your data and set up security so that only authorized users can see the data.
- Download and unzip the sample research data to the location of your choice.
- Log in to your server and navigate to your "Tutorials" project. Create it if necessary.
- If you don't already have a server to work on where you can create projects, start here.
- If you don't know how to create projects and folders, review this topic.
- Create a new subfolder named "Study Tutorial". Choose folder type "Study" and accept other defaults.
- On this New Study page, click Create Study.
Set Study Properties
Study properties are where you store some basic information about your study, including a name, identifying information, a protocol document, etc. You may also customize the word used to describe individual participants in a study (participants, subjects, mice, etc.)
The Study Label
is the title shown in the top banner of your study - it does not need to match the underlying folder name, which is the default. Notice that the word "Study" is appended automatically to the label; you could edit it here if you like.
In this tutorial, you will create a date-based study with editable datasets and simple specimen tracking.
For this tutorial, change the default study properties to the values below:
- Under Visit/Timepoint Tracking:
- Timepoint Style: Dates
- Start Date: 2008-04-01
- Default Timepoint Duration: 28
- Under Specimen Management:
- Repository Type: Standard Specimen Repository (if it is not selected by default)
- Under Security:
- Security Mode: Basic security with editable datasets
Note that if your browser window is narrow, your tabs will be collapsed to a pulldown menu indicated by a icon next to the current tab name. Click to see the other tabs available.
On the Manage
tab, click Change Study Properties
to see the study properties again, plus some optional fields not offered in the initial creation step. Click Cancel
to exit this page when finished reviewing them.
- Investigator/Grant/Species: Providing values for the investigator, grant, or species allows later filtering of a large number of studies by these attributes.
- Description: The content entered here will be displayed on the overview tab. You might include the study abstract, for example. You can use formatting syntax (HTML, Markdown, etc); select the appropriate render type below. If no description is entered, the overview tab will show the numbers of datasets, time points, and participants present in the study.
- Render Type: Select how to interpret the description entered above: plain text, HTML, Wiki, or Markdown syntax.
- Subject Noun (Singular and Plural forms): The subject noun typically indicates the organism being investigated, for examples, "Mouse", "Mosquito", "Participant". This noun will be used throughout the user interface of the study.
- Subject Column Name: The is the default column name containing subject ids. Your data does not need to conform to this column name. It is only the default used by the server.