search

AlexsLemonade / scpca-docs

User information about ScPCA processing
https://scpca.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Add link to code for QC report #30

Closed allyhawkins closed 3 years ago

allyhawkins commented 3 years ago

Closes #19. Here I'm adding a FAQ that includes information about how we generated the QC report. I included a link to the template for the QC report and then also provided some explanation on how we got the input needed for the QC report. I think some of it might be repetitive, but I thought it would be nice to have some context of what goes into the QC report and not just give the link to the code, but open to other suggestions on how to frame this.

I also included a link to the scpcaTools package as I thought it could be useful for people to have somewhere.

allyhawkins commented 3 years ago

@jashapiro I like the changes you made in terms of linking to previous sections more so I went ahead and implemented them and then made the minor formatting changes to fix the links. I wasn't sure about linking to a tagged version or not, but did so because we did it for the splici code from the scpca-nf repo. Should we also change that link then?

jashapiro commented 3 years ago

I wasn't sure about linking to a tagged version or not, but did so because we did it for the splici code from the scpca-nf repo. Should we also change that link then?

I think that is where I was leaning, which was what I meant when I made a reference to previous FAQ questions as well. I think I would rather people see the lastest code from the docs, even if it is not exactly the code that was used for a particular sample. If people need to track that down, they will have to look at the version tagged in the metadata (as the docs might not correspond anyway as we update them).

allyhawkins commented 3 years ago

Okay I went ahead and updated the splici link accordingly.