Set up a REDCap Project

Steps

To create a REDCap project, please follow these steps:

0. Check if your instituion hase a REDCap instance.

1. Contact your local REDCap administrator to create your REDCap project with

   BioPortal ontology service.

2. Name your REDCap project, e.g.:

   • RareLink - NameofyourInstitution or

   • RareLink - NameofyourProject.

3. Let your institutional account be added and given API access for the project.

4. Follow the instructions given to you by your REDCap administator to further set up your project.

5. Copy the API token for the project and keep it secure.

6. Run rarelink setup keys to set up the REDCap API access locally.

Note

Be aware of the REDCap development and production mode. Read the REDCap section and discuss this with your REDCap administrator!

Note

BioPortal must be connected to your REDCap instance to use the ontology service. If you cannot see this option in your REDCap setup, contact your REDCap administrator.

---

Next Steps and further reading

• Read the REDCap section to learn more about the REDCap API access.

• Read RareLink CLI to learn more about the RareLink Command Line Interface (CLI)

• Read RareLink User Guide to learn more about the RareLink User Guide.

---

RareLink CLI Commands

rarelink setup redcap-project

• This command will guide you through the same steps above. If you have questions, please reach out to us or your local REDCap administrator.

• Make sure to run

rarelink setup keys

after you have set up the REDCap project to store the REDCap API token.

Attention

The REDCap API token is a sensitive information. Keep it secure and do not share it with others.

---