Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C2M2 Docs lacking #210

Open
u8sand opened this issue Mar 29, 2024 · 4 comments
Open

C2M2 Docs lacking #210

u8sand opened this issue Mar 29, 2024 · 4 comments

Comments

@u8sand
Copy link
Contributor

u8sand commented Mar 29, 2024

Though https://info.cfde.cloud/info/standards/C2M2 has a lot of information; someone who is completely clueless about the C2M2 will not be able to assemble a C2M2 data package with the provided information. I suggest we adopt some of the docs that were developed in the past to successfully onboard the current DCCs about C2M2 (https://docs.nih-cfde.org/en/latest/c2m2/draft-C2M2_specification/index.html).

Some areas I find missing:

  • what is frictionless / what is a datapackage
  • diagram of the C2M2
  • dcc_contact
  • identifiers
  • LINCS is not the best example since it's lacking elements common in clinical settings (of which many DCC's data are from)
sherxie added a commit that referenced this issue Apr 4, 2024
@mano-at-sdsc
Copy link
Collaborator

I agree. I tried to find the source of pages like https://github.com/nih-cfde/published-documentation/wiki/TableInfo:-biosample_from_subject.tsv (e.g. from where the information the table formats explained there is coming) but couldn't locate it. Of course, from C2M2_datapackage.json, we can populate most of the content of the table, but not the explanatory text above it. We can create such pages brute-force if cannot figure out the github source page/file.

@mano-at-sdsc
Copy link
Collaborator

Thanks, @u8sand for sharing https://github.com/nih-cfde/published-documentation.wiki.git . @sxie04, are you already looking into cross-checking and putting this documentation inside DRC-Portals e.g., in a folder inside https://github.com/MaayanLab/DRC-Portals/tree/main/drc-portals/app/info/standards/markdown ? If not, we can work on it. Please let us know.

@sherxie
Copy link
Contributor

sherxie commented Apr 11, 2024

Hi @mano-at-sdsc, right now I'm working on quoting sections and linking to the original documentation from the Standards page. I don't believe we currently plan to have a duplicate copy of all the documentation in DRC-Portals since we are not the original creators, but we can also discuss further once I merge the newest changes.

@mano-at-sdsc
Copy link
Collaborator

Thanks, @sxie04.

sherxie added a commit that referenced this issue Apr 24, 2024
* Update C2M2 text (#210)
* Fix link rendering
* Handle external C2M2 doc rendering (#167)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants