OHDSI Home | Forums | Wiki | Github

User guides of OHDSI apps

Are there efforts underway to create user guides for the OHDSI apps?

Yes, although this is an area where we could certainly use a lot of help. I’m actually testing out a process for generating some video tutorials for apps, I should have a sample done in the next week or so and I’ll share it to gather feedback.

@anthonysena we’re very happy to see the documentation you’ve added to the Atlas wiki. As I’ve mentioned on the architecture call, at Columbia we put together a cookbook that we share with our end-users to help guide them through some basic Atlas use cases. We’ve merged it into the wiki and made it available on a github repo. Can you please take a look at it and let us know if/how you’d like to “promote” this to be an OHDSI resource? We also welcome any suggestions; are happy to follow along with your vision of documentation.

Hi @mark_velez - thanks for reaching out. I’ve pulled down the documentation to browse through it - hoping to get more time later this week to review. At first glance, I think this will be a very valuable addition so thanks for sharing it. I’ll reach out with some ideas so we can get it incorporated into what we have posted on Atlas.

@Jungmi and I will soon be updating the cookbook for Atlas version 1.0. We look forward to your feedback. Unfortunately github doesn’t support pull requests to repo wikis, right? :smile:

@mark_velez - we can certainly open the wiki for direct contributions as it doesn’t appear to be a way to propose changes. I did a review of the cookbook and I really like the way you’ve approached the scenarios and the descriptions for using Atlas to carry out the tasks. As you mentioned, we’ll need to make some updates to make the descriptions match up to what is in Atlas 1.0. I’m happy to help with those edits (as I started to make some this morning) so perhaps we can do that in the repo you set up? Once that’s done we should pull your contributions into the Atlas wiki and just work together in that space.

Has the user guide been released (as of now)? What is the URL?

Hi Voijtech,

Yes, a preliminary user guide has been posted to the Atlas wiki here: https://github.com/OHDSI/Atlas/wiki. I have yet to incorporate the work done by @mark_velez and his team. Hope this helps!

t