You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pephub/user/getting-started.md
+10-14
Original file line number
Diff line number
Diff line change
@@ -7,42 +7,38 @@ Just like GitHub allows you to share and edit projects that you are tracking wit
7
7
-**Upload** your metadata to a central database
8
8
-**Edit** your metadata in a web interface
9
9
-**Share** your metadata with collaborators
10
+
-**Validate** your metadata using a schema
11
+
-**Access** and update metadata programmatically through an API, from Python or R.
10
12
11
13
## What is a PEP?
12
14
13
-
Portable Encapsulated Projects (PEPs) are standard format for biological sample metadata. A PEP is simply a **yaml** + **csv** file (or just csv) -- the CSV file is a sample table, while the YAML file provides project-level metadata and sample modifiers. PEPs are a common input for running workflows using tools such as [Snakemake](https://snakemake.readthedocs.io/en/stable/), [Common Workflow Language](https://www.commonwl.org/), [Looper](http://pep.databio.org/looper), and other workflow systems. For more details, read the [PEP specification](http://pep.databio.org/spec/simple-example).
15
+
Portable Encapsulated Projects (PEPs) are standard format for biological sample metadata. A PEP is simply a **csv** file representing a sample table, plus an *optional***YAML** file for project-level metadata and sample modifiers. For more details, read the [PEP specification](http://pep.databio.org/spec/simple-example).
14
16
15
-
## How PEPhub and PEPswork together
17
+
PEPhub gives you a platform to store and collaborate on your PEPs. This makes it easier to work together for large or small teams. Instead of relying on local files that you send back-and-forth, PEPhub provides a centralized interface and API that simplifies sharing and collaboration.
16
18
17
-
PEPhub gives you a central location to store and collaborate on your PEPs. This makes it easier to work together for large or small teams. Instead of relying on local files that you send back-and-forth, PEPhub provides a centralized interface and API that simplifies sharing and collaboration.
19
+
## Your first PEP on PEPhub
18
20
19
-
In short, PEPs are the standard format for biological metadata, and PEPhub is the platform that allows you to store, edit, and share these PEPs. Through the API, one can easily access and retrieve PEPs for use in workflows and analyses.
21
+
### Logging in
20
22
21
-
## Logging into PEPhub
22
-
23
-
PEPhub accounts are linked to GitHub. This allows us to leverage GitHub's OAuth system for secure authentication and namespacing. Once you have a [GitHub account](https://github.com/signup), you can log in to PEPhub. Just click the "Login" button in the top right corner of the [PEPhub home page](https://pephub.databio.org).
23
+
You log in to PEPhub using your [GitHub account](https://github.com/signup). Just click the "Log in" button in the top right corner of the [PEPhub home page](https://pephub.databio.org).
24
24
25
25

26
26
27
27
You will be redirected to GitHub to authorize the PEPhub application. You are now logged in and can upload your first PEP! There are two mains ways to add a PEP to your PEPhub namespace: you can either [upload a PEP directly](#uploading-a-pep), or you can [create a new PEP from scratch](#creating-a-new-pep-from-scratch) using the web interface. This guide will walk you through both methods.
28
28
29
-
## Uploading a PEP
29
+
###Uploading a PEP
30
30
31
31
Navigate to your PEPhub namespace (`https://pephub.databio.org/{github username}`) and click the "Add" button in the top right. Click the "Upload PEP" tab. You will be prompted to select a PEP file from your local machine. Fill in the details about your PEP and then either drag files to the drop zone or click the drop zone to select files from your computer. Click "Submit" to add the PEP to your namespace.
32
32
33
-
## Creating a new PEP from scratch
33
+
###Creating a new PEP from scratch
34
34
35
35
Navigate to your PEPhub namespace (`https://pephub.databio.org/{github username}`) and click the "Add" button in the top right. Click the "Blank PEP" tab. Again, fill in the details about your PEP and then you can start filling in the sample table. Click "Submit" to add the PEP to your namespace.
36
36
37
37

38
38
39
-
## Ready to edit your PEP
40
-
41
-
Once you have uploaded or created a PEP, you can now start using it in pipelines!
42
-
43
39
## Editing a PEP
44
40
45
-
Editing a PEP is easy; just make changes in the table and click `Save` when you are finished.
41
+
Once you have uploaded or created a PEP, you can edit it. Editing a PEP is easy; just make changes in the table and click `Save` when you are finished.
0 commit comments