On-site setup

Topics:

Creating a project

  1. Create your project

    1. Go to your project management page.
    2. Select "Create a new on-site data request project".
    3. Fill in some project details. (You can edit these later!)
    4. Click "Create project".

  2. View project details
    To view project details:

    1. Go to your project management page.
    2. Click on your project's name.
  3. Edit configuration
    To update project configuration:

    1. Go to your project management page.
    2. Find on your project name.
    3. Click the "Edit" button.

    (See below for more information on configuration items.)

  4. Draft your consent
    Your consent document should be added to project configuration. Use Markdown syntax to add headers, links, etc. You can refine this document as you get feedback from your test users (see below).

  5. Send test users to the "signup URL"
    View project details to find the project's "signup URL".

    Send test users to this URL to join your project. Up to 20 users can join. (Note: your own account can be a test user too!) Users should be able to go through the enrollment and authorization process.

  6. Test withdrawal/deauthorization and reauthorization
    Members can immediately withdraw/deauthorize a project on their connections management page.

    You can reauthorize a project by returning to its "signup URL".

    If a project changes requested permissions, new permissions will take effect only if/when a member has reauthorized the project.

  7. Test API data access
    If any test users have data from requested sources, it will become accessible to your project. Check that data access is working correctly.

  8. Test messaging
    If your project is planning to send messages to users, you can test this feature by sending messages to your test users.

  9. Test data upload
    If your project is planning to add or return data to member accounts, you can test the data upload process.

  10. Review project guidelines.
    Review our Project Guidelines and ensure your project has good security and responsible data management practices before seeking project approval.

  11. Request project approval.
    Project approval is required to remove the 20 user cap. Once approved, we'll share your project with Open Humans members. For approval, we require any project classified as a "study" to have been reviewed and approved by an Institutional Review Board or equivalent ethics board.

    The project approval process is performed with feedback from the larger Open Humans community. Project approval is discussed publicly on our Discourse and project members are asked to weigh and ask questions to the project leads. A step-by-step guide can be found in our Approval How-To.

Closing a project

When you no longer wish to have new members join your project, edit your project's configuration to turn off "Active" status.

Configuration details

  • Study or activity?
    Are you doing research? If so, you're a "study". We expect all studies to have be approved by an Institutional Review Board (IRB) or equivalent ethical review.

    Non-study projects are also welcome, for example: data analysis tools, or projects to enable import of a certain type of data.

  • Project name
    Your project will be listed with this name. This name will also be used to within the "join URL" for your project.

  • Leader(s) or Principal Investigator(s)
    These will be listed in your project description.

  • Organization or Institution
    This will be listed in your project description.

  • Academic or non-profit?
    Select "yes" if your project's affiliation is academic or nonprofit. This affects how your project is listed in Open Humans.

  • Contact email for your project
    Members who wish to contact your project will use this email address. If your project sends messages, this email will be the "reply-to" in the emails members receive.

  • URL for general information about your project
    Members who want more information about your project can follow this URL to learn more.

  • Short description
    This description will be displayed for members when your project is listed.

  • Long description
    A longer description for members. (Note: This field isn't currently in use by our site, but might be later.)

  • Description of data you plan to upload to member accounts
    Describe any data your project is planning to add or return, via upload to the accounts of your project's members. Leave this blank if your project doesn't plan to add or return data via Open Humans.

  • Active
    Members can only join a project if it is "active". You should answer "Yes" during development to enable testing the join & authorization process.

    When you wish to close a study enrollment (i.e. no new members may join), remove "active" status for your project.

  • Badge image
    Badges should be circular images. Members that join your project will have this badge displayed on their profile.

  • Request sources access
    Select all data sources that you're requesting members to share with your project. New and updated data held by members will be shared in an ongoing manner as long as your project is authorized.

  • Are you requesting permission to message users?
    Answer "Yes" if you want your project to be authorized to send messages.

  • Are you requesting Open Humans usernames?
    Answer "Yes" if you want your project to have access to the usernames of your project members. This implicitly enables access to anything the user is publicly sharing on Open Humans.

    Username information is also potentially sensitive and/or identifying. You might want to avoid username access to improve security and potentially facilitate IRB review.

  • Consent text
    This text is presented to all Open Humans members that wish to join your project. Use Markdown syntax to add headers, links, etc.

  • Post-sharing URL
    If provided, after authorizing sharing the member will be taken to this URL. If this URL includes "PROJECT_MEMBER_ID" within it, we will replace that with the member's project-specific project_member_id. This allows you to direct them to an external survey you operate (e.g. using Google Forms) where a pre-filled project_member_id field allows you to connect those responses to corresponding data in Open Humans.