Skip to content

Commit 8b2c39a

Browse files
committed
simplify
1 parent 7f1aea8 commit 8b2c39a

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

Diff for: docs/pephub/user/getting-started.md

+10-14
Original file line numberDiff line numberDiff line change
@@ -7,42 +7,38 @@ Just like GitHub allows you to share and edit projects that you are tracking wit
77
- **Upload** your metadata to a central database
88
- **Edit** your metadata in a web interface
99
- **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.
1012

1113
## What is a PEP?
1214

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).
1416

15-
## How PEPhub and PEPs work 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.
1618

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
1820

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
2022

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).
2424

2525
![PEPhub login button](../img/login.png)
2626

2727
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.
2828

29-
## Uploading a PEP
29+
### Uploading a PEP
3030

3131
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.
3232

33-
## Creating a new PEP from scratch
33+
### Creating a new PEP from scratch
3434

3535
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.
3636

3737
![Submission form for a new PEP](../img/add-pep-form.png)
3838

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-
4339
## Editing a PEP
4440

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.
4642

4743
## Sharing your PEP
4844

0 commit comments

Comments
 (0)