search

ProtProtocols / IsoProt

Protocol of the analysis of iTRAQ/TMT proteomics data including quantification, statistical analysis and maybe clustering
https://protprotocols.github.io
11 stars 4 forks source link

Improve the README a bit (more newbie friendly) #81

Closed joncison closed 5 years ago

joncison commented 5 years ago

Nice work folks

I'm trying (and struggling :) to orientate myself with the repo.

Appreciate everything is at an early stage, but what would help is addition of a table to https://github.com/ProtProtocols/IsoLabeledProtocol which includes the directory and file names (col. A) and short note (col. B) explaining what is kept in that directory / file.

Thanks!

veitveit commented 5 years ago

Hi Jon,

Thanks for looking into our repo :-) and for helping us with our presentation.

We wanted to keep the README rather short and describe only how to load the Docker image as most of the documentation is in there. But as it seems, this is not clear. We will revise the README soon as it can now be loaded and used much easier with the https://github.com/ProtProtocols/docker-launcher which is supposed to be super user-friendly and does not require any command line activities.

With the table, do you mean the directory in the docker image or the one at github?

joncison commented 5 years ago

I meant the directory structure / files in GitHub, just so I know what's kept in "Scripts", in "Test", what run.sh is for etc. This probably all is obvious, if I'd spent more time ... I'm a bit of a docs-nerd, so forgive me if I'm being OTT.

veitveit commented 5 years ago

No, point taken! We will improve the description of folders. They have been changed quite a lot recently which explains the current disorganization

Am Fr., 5. Okt. 2018 um 14:03 Uhr schrieb Jon Ison <notifications@github.com

:

I meant the directory structure / files in GitHub, just so I know what's kept in "Scripts", in "Test", what run.sh is for etc. This probably all is obvious, if I'd spent more time ... I'm a bit of a docs-nerd, so forgive me if I'm being OTT.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/ProtProtocols/IsoLabeledProtocol/issues/81#issuecomment-427341760, or mute the thread https://github.com/notifications/unsubscribe-auth/APEZhcXwRkt5oow01qshQD7yrp0kCguZks5uh0qMgaJpZM4XKBLk .

-- |||/ (o o) ----ooO-(_)-Ooo----

Don't worry about life; you're not going to survive it anyway.

http://computproteomics.bmb.sdu.dk

jgriss commented 5 years ago

@joncison Thanks a lot for the feedback!

@veitveit I'll take care of a first update - also with respect to docker-launcher, OK?

veitveit commented 5 years ago

Sure, go ahead

Am Fr., 5. Okt. 2018 um 14:49 Uhr schrieb Johannes Griss < notifications@github.com>:

@joncison https://github.com/joncison Thanks a lot for the feedback!

@veitveit https://github.com/veitveit I'll take care of a first update

  • also with respect to docker-launcher, OK?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ProtProtocols/IsoLabeledProtocol/issues/81#issuecomment-427354970, or mute the thread https://github.com/notifications/unsubscribe-auth/APEZhVfFk1u-JryeBb1XumMXRJ5FPGktks5uh1VTgaJpZM4XKBLk .

-- |||/ (o o) ----ooO-(_)-Ooo----

Don't worry about life; you're not going to survive it anyway.

http://computproteomics.bmb.sdu.dk

jgriss commented 5 years ago

@veitveit @joncison Is this version more helpful?

Any suggestions are highly welcome!

joncison commented 5 years ago

Thanks a lot for the fast action, already it is much more user-friendly. When I have time to seriously have a play with this stuff, I'll get back in more details.

jgriss commented 5 years ago

@joncison Great! I'll close this issue for now. If you find anything else, just add a new issue!

Thanks a lot for your help!