swinterbourne / riboviz-work

1 stars 2 forks source link

Further Reading section #16

Open ewallace opened 2 years ago

ewallace commented 2 years ago

We need to make a Further Reading section, and strip citations/links from the text. See for example Beginner’s guide to CRISPR-Cas9-based gene editing.

From Instructions to Authors:

Sources and further reading

  • Please do not include references within the text, either parenthetically or as a numbered list (these will be removed to fit with house style for the magazine).
  • Key references pertaining to your article should be included in a ‘Further reading’ section at the end of your article, of ideally 5-10 items that will be beneficial to readers interested in knowing more about the topic.
  • Given the nature of feature articles in The Biochemist, further reading might include academic research articles or reviews, articles published in the media and specialist media (for example, an article in the New Scientist), a government report, a relevant website or article published on such a website, or a relevant blog article.
ewallace commented 2 years ago

To include:

swinterbourne commented 2 years ago

In branch further-reading-section-16 I have added a further reading section at the bottom.

I tried to follow the format set out in the example "Beginner's guide to CRISPR-Cas9 based gene editing" and have added the items listed here:

To include:

For the riboviz website item I included the reference for the riboviz software and its doi - if this is incorrect I can change it.

Unless any other resources are to be added should I put in a pull request @ewallace?

ewallace commented 2 years ago

This looks good. It's ready for a pull request.

Can we add some further reading on git and github for researchers? I'll look around for that. I'll also create a new issue ticket that we need a 1-sentence explanation of git/github/issue tickets when it's first brought up in the article, because many readers of the biochemist might be unfamiliar with those.

Can we edit: "For Carpentries" > "The Carpentries, organisation and materials teaching coding skills to researcher" "For iGEM MSc projects" - I should have explained that better. You've put in a link to iGEM. I was hoping there might be some link or explanation to using iGEM for MSc research projects. Should I ask e.g. Holly Robertson-Dick about that?

@FlicAnderson do you have any other ideas about resources we should add?

ewallace commented 2 years ago

Let's add: Ten arguments against Open Science That you can win: https://www.software.ac.uk/blog/2020-12-17-ten-arguments-against-open-science-you-can-win

ewallace commented 2 years ago

@FlicAnderson and @swinterbourne will work to resolve this pull request #23, then we will close this issue.

FlicAnderson commented 2 years ago

@ewallace to follow up with Holly Robertson-Dick about iGEM for MSc Research re: above comment

Updated by @ewallace: I emailed Holly Robertson-Dick and Elise Cachat to ask for a reference.

FlicAnderson commented 2 years ago

23 was merged in the further reading section to main, but we're not closing this issue just yet until we decide whether we should add some reading resources on GitHub.

We tossed a few ideas back and forth:

https://github.blog/2014-05-14-improving-github-for-science/ - a blog post on using github in science (probably too short & not general enough?)

https://guides.github.com/activities/hello-world/ - this is a tutorial, with a 'what is github' section at the start, but perhaps linking to a tutorial is a bit much if people just want more information about what github is?

https://unito.io/blog/beginners-guide-to-github/ - this is a fairly good guide to the different features of GitHub, but assumes familiarity with Git & is aimed at folks about to use GitHub, not people new to the concept, I think. This alternative guide is aimed at non-developers, but the 'project managers' title might put off non-developer non-project-managers?: https://unito.io/blog/guide-to-github-for-project-managers/

Also: this might be a good reading resource for 'Git':
https://guides.github.com/introduction/git-handbook/ - Git handbook

This might be something people reading for review (#20) might suggest, so perhaps it's worth keeping these ideas in mind?

ewallace commented 2 years ago

I think iGEM link more informative to go directly to:

Student projects connected to the iGEM competition https://igem.org/Competition

swinterbourne commented 2 years ago

I have updated the iGEM link in the branch further-reading-16.

Should I add any of the links that Flic mentioned in this comment before I merge it in?

ewallace commented 2 years ago

Thanks @swinterbourne! I think add:

Then pull request in?