Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
This adds pip installation instructions ("bleeding edge" git+https)
and reorganizes badges to separate docs from CI.
  • Loading branch information
mslw committed Feb 10, 2023
1 parent 9b6b5f9 commit 9482eaa
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
# DataLad REDCap extension

| Docs | CI | Other |
|---|---|---|
| [![Documentation Status](https://readthedocs.org/projects/datalad-redcap/badge/?version=latest)](http://docs.datalad.org/projects/redcap/en/latest/?badge=latest) | [![crippled-filesystems](https://github.com/datalad/datalad-redcap/workflows/crippled-filesystems/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/test_crippledfs.yml) [![docs](https://github.com/datalad/datalad-redcap/workflows/docs/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/docbuild.yml) | |


| **Docs** | [![Documentation Status](https://readthedocs.org/projects/datalad-redcap/badge/?version=latest)](http://docs.datalad.org/projects/redcap/en/latest/?badge=latest) |
|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **CI** | [![crippled-filesystems](https://github.com/datalad/datalad-redcap/workflows/crippled-filesystems/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/test_crippledfs.yml) [![docs](https://github.com/datalad/datalad-redcap/workflows/docs/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/docbuild.yml) |

[![docs](https://github.com/datalad/datalad-redcap/workflows/docs/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/docbuild.yml)

[![crippled-filesystems](https://github.com/datalad/datalad-redcap/workflows/crippled-filesystems/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/test_crippledfs.yml)
[![docs](https://github.com/datalad/datalad-redcap/workflows/docs/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/docbuild.yml)
[![Documentation Status](https://readthedocs.org/projects/datalad-redcap/badge/?version=latest)](http://docs.datalad.org/projects/redcap/en/latest/?badge=latest)

This DataLad extension provides convenience commands for exporting data from REDCap into DataLad datasets.
Information about the RedCAP project can be found at https://project-redcap.org/.

The extension is in early development.

## Installation
The extension has no official release yet, but you can install the *bleeding edge* version using pip, directly from GitHub.
This will also install the latest development version of [DataLad Next](https://github.com/datalad/datalad-next) extension.
Using a virtual environment is recommended.
Example installation:

``` bash
# create and enter a new virtual environment (optional)
$ virtualenv --python=python3 ~/env/dl-redcap
$ source ~/env/dl-redcap/bin/activate
# install from GitHub main branch
$ python -m pip install git+https://github.com/datalad/datalad-redcap.git@main
```

## Commands
- `export-redcap-form`: Export records from selected forms (instruments)
- `export-redcap-report`: Export a report that was defined in a project
Expand Down

0 comments on commit 9482eaa

Please sign in to comment.