[READY FOR REVIEW] Electronic Lab Notebooks Chapter #3466

RichardJActon · 2023-12-06T13:35:46Z

Summary

Electronic lab notebooks are currently addressed in a chapter in research data management on methods. It is also mentioned in a chapter in open research on open notebooks. ELNs are an important enough subject to deserve their own chapter within research data management and this PR creates one. It inserts references to this new chapter in the two previous locations which mentioned ELNs. It also moves and slightly re-works the content on ELNs from previous section in methods, whilst providing an extended discussion on considerations when selecting and ELN solution.

Fixes #3434

Direct link to the Chapter preview

List of changes proposed in this PR (pull-request)

Create new ELN chapter
Link to it from the previous places that touch on ELNs
Move and slightly re-work existing ELN content from methods to the new chapter

What should a reviewer concentrate their feedback on?

lightly opinionated as a free software guy lean quite heavily on the 'go with an open solution if you can' side of the scales, let me know if I've gone too far.
Spelling a grammar, (I'm dyslexic so this can be pretty hit and miss)

Acknowledging contributors

All contributors to this pull request are already named in the table of contributors in the README file.
The following people should be added to the table of contributors in the README file:

netlify · 2023-12-06T13:35:52Z

✅ Deploy Preview for the-turing-way ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`8010c45`
🔍 Latest deploy log	https://app.netlify.com/sites/the-turing-way/deploys/65c3a607f60f080008aeacb6
😎 Deploy Preview	https://deploy-preview-3466--the-turing-way.netlify.app/reproducible-research/rdm/rdm-elns
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

book/website/reproducible-research/rdm/rdm-elns.md

EstherPlomp

Looks very nice - thanks for adding!

I have some structure concerns which I think are very easily addressed by adding another sub section on differences between paper and ELNs, instead of adding this information into the 'how to pick an ELN solution.

book/website/reproducible-research/rdm/rdm-elns.md

EstherPlomp · 2023-12-11T19:48:20Z

book/website/reproducible-research/rdm/rdm-elns.md

+## Choosing an ELN solution
+
+The choice of ELN may have been made for you by your organisation.
+In this case you may have to live with the consequences of their choice, for good or ill.


Suggested change

In this case you may have to live with the consequences of their choice, for good or ill.

EstherPlomp · 2023-12-11T19:48:59Z

book/website/reproducible-research/rdm/rdm-elns.md

+In this case you may have to live with the consequences of their choice, for good or ill.
+If you are in a position to choose an ELN to use, or are making a choice on behalf of an organisation here are some factors to consider.
+
+There are an immense and baffling array of options in the Electronic Lab Notebook space.


Suggested change

There are an immense and baffling array of options in the Electronic Lab Notebook space.

There are many options in the Electronic Lab Notebook space.

book/website/reproducible-research/rdm/rdm-elns.md

I want of make it clear that there exists a seperate type of software, LIMS, which has a different domain of responsibility from an ELN and that ELNs somtimes contain LIMS functionality. Integration of ELNs and LIMS is very useful but LIMS functionality, where it exists in ELNs, can be limited in comparison to dedicated LIMS solution. If you have a big high throughput lab you may need to find a seperate dedicated LIMS in addition to your ELN

RichardJActon · 2023-12-13T11:45:37Z

Looks very nice - thanks for adding!

I have some structure concerns which I think are very easily addressed by adding another sub section on differences between paper and ELNs, instead of adding this information into the 'how to pick an ELN solution.

Thanks for the thoughtful review @EstherPlomp I agree about restructuring this a little - it does look like a bit of a wall of text at the moment when I actually look at it in the preview.

I actually want to avoid the 'paper vs ELN' then 'now I know I want an ELN which ELN should I pick' framing. I'm trying to frame the choice of ELN in terms of which ELNs best permit you to retain the advantages of paper AND benefit from the advantages of ELNs. I think that paper notebooks are actually THE most important point of comparison for ELN solutions NOT other ELNs, as paper is the default that they are trying to replace.

It does not matter how wiz-bang your ELNs features are if it can't do the fundamentals, there is of course an element of trade-off. However, there are certain things that paper comes with by default, that ELNs do not. These should probably be high priority features in most prospective ELN users' use cases, but are often not given enough attention - in my view.

I've got some thoughts on how to keep this framing and improve the structure that I'll play around with over the next little bit.

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

EstherPlomp · 2024-01-26T18:15:24Z

Perhaps another add for the additional resources! An ELN finder that I found out about today: https://eln-finder.ulb.tu-darmstadt.de/home

EstherPlomp · 2024-01-30T20:37:16Z

It looks like you added all the changes/suggestions? Shall I review again or are you still working on something? No rush - please let me know whenever it is ready to review so we can get this merged!

book/website/reproducible-research/rdm/rdm-elns.md

Co-authored-by: Danny Garside <dannygarside@outlook.com>

EstherPlomp

Looks good to me! Thanks for doing all the revisions!

RichardJActon added 3 commits November 26, 2023 00:32

Move section on ELNs to its own sub-chapter, and cross reference

8ea6b95

Add initial text from HackMD

170b846

Restructure and clean-up on ELN sub-chapter

2309944

RichardJActon added 4 commits December 6, 2023 13:39

remove 'e.g.'s and some quarto section label syntax I missed

460ec54

add elns page to toc

96fee55

decrement header levels

b3d939a

Add Open Notebooks chapter links

87b7a03

RichardJActon changed the title ~~Electronic Lab Notebooks Chapter~~ [READY FOR REVIEW] Electronic Lab Notebooks Chapter Dec 6, 2023

jezcope reviewed Dec 6, 2023

View reviewed changes

book/website/reproducible-research/rdm/rdm-elns.md Outdated Show resolved Hide resolved

typo: collection to connection

fcba5d0

EstherPlomp requested changes Dec 11, 2023

View reviewed changes

RichardJActon and others added 16 commits December 13, 2023 16:54

Rephrase OSF sharing

43b28cf

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Rephrase openBIS hosting

ab76584

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

openBIS pricing punctuation

8ceb431

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Rephrase physical vs digital security, split long sentence

a130506

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

3rd to third

9f7352b

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

split long sentence

cbac7d0

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Punctuation

7942753

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Spelling and Grammar

f8d679e

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Split long sentence

39caeb8

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Grammar: appropriate capitalisation

3c010ea

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

eLabFTW rephrase features and & to and

5e88238

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Grammar, and -

aa32c94

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Spelling exort to export, garunteed to guaranteed

7c7db01

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Rephrase, 3rd to third

3b97a11

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Rephrase: more concise

601f82e

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Split long sentence

ccd2e33

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

RichardJActon and others added 12 commits January 25, 2024 18:50

Dissambiguate VM abreviation

f7fcfba

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Spelling

e8be939

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Appropriate Capitalisation

782743e

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Spelling

dfe39a2

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Sense

4b068a5

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Grammar: add comma

a645366

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Grammar: add full stop appropriate capitalisation

5b32036

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Remove redundant sentance - added in parens

6f39b87

Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>

Clarify sentence

f64204a

archival format rephrase and reorder

a63fdec

vendor lock-in cross reference

7322151

Merge branch 'main' into ELNs

46e74d2

RichardJActon and others added 4 commits January 26, 2024 22:45

Add ELN finder to additional resources

857a2c9

Merge branch 'main' into ELNs

99cb62c

move ELN finder link to rescources for choosing ELNs section

1ff7251

Merge branch 'ELNs' of github.com:RichardJActon/the-turing-way into ELNs

c527d98

Merge branch 'main' into ELNs

ec283ad

da5nsy reviewed Feb 7, 2024

View reviewed changes

book/website/reproducible-research/rdm/rdm-elns.md Outdated Show resolved Hide resolved

da5nsy reviewed Feb 7, 2024

View reviewed changes

book/website/reproducible-research/rdm/rdm-elns.md Outdated Show resolved Hide resolved

da5nsy reviewed Feb 7, 2024

View reviewed changes

book/website/reproducible-research/rdm/rdm-elns.md Outdated Show resolved Hide resolved

RichardJActon and others added 5 commits February 7, 2024 15:38

missing comma in references.bib

0aae49b

More missing commas and a curly brace in references.bib

c126f47

Apropriate capitalisation

6b89db0

Co-authored-by: Danny Garside <dannygarside@outlook.com>

rephrase

50aeb2d

Co-authored-by: Danny Garside <dannygarside@outlook.com>

Grammar

8010c45

Co-authored-by: Danny Garside <dannygarside@outlook.com>

EstherPlomp approved these changes Feb 7, 2024

View reviewed changes

RichardJActon merged commit b8f15f7 into the-turing-way:main Feb 7, 2024
14 checks passed

aleesteele mentioned this pull request Feb 7, 2024

Promotion for new Computational Notebooks chapter the-turing-way/2024-rcm-rpm-tasks#23

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[READY FOR REVIEW] Electronic Lab Notebooks Chapter #3466

[READY FOR REVIEW] Electronic Lab Notebooks Chapter #3466

RichardJActon commented Dec 6, 2023 •

edited

netlify bot commented Dec 6, 2023 •

edited

EstherPlomp left a comment

EstherPlomp Dec 11, 2023

EstherPlomp Dec 11, 2023

RichardJActon commented Dec 13, 2023

EstherPlomp commented Jan 26, 2024

EstherPlomp commented Jan 30, 2024

EstherPlomp left a comment

	There are an immense and baffling array of options in the Electronic Lab Notebook space.
	There are many options in the Electronic Lab Notebook space.

[READY FOR REVIEW] Electronic Lab Notebooks Chapter #3466

[READY FOR REVIEW] Electronic Lab Notebooks Chapter #3466

Conversation

RichardJActon commented Dec 6, 2023 • edited

Summary

List of changes proposed in this PR (pull-request)

What should a reviewer concentrate their feedback on?

Acknowledging contributors

netlify bot commented Dec 6, 2023 • edited

✅ Deploy Preview for the-turing-way ready!

EstherPlomp left a comment

Choose a reason for hiding this comment

EstherPlomp Dec 11, 2023

Choose a reason for hiding this comment

EstherPlomp Dec 11, 2023

Choose a reason for hiding this comment

RichardJActon commented Dec 13, 2023

EstherPlomp commented Jan 26, 2024

EstherPlomp commented Jan 30, 2024

EstherPlomp left a comment

Choose a reason for hiding this comment

RichardJActon commented Dec 6, 2023 •

edited

netlify bot commented Dec 6, 2023 •

edited