sr320 / course-fish546-2021

1 stars 1 forks source link

Setting up Projects #6

Closed sr320 closed 3 years ago

sr320 commented 3 years ago

Based on the reading, what would you consider are the two most important things to consider when setting up a bioinformatics project?

aspencoyle commented 3 years ago
  1. Keep a cohesive, well-organized directory! All files for a single project inside one directory, clearly-named subdirectories, consistently-named files, and so on

  2. Document in a README file! Describe where/when/how you obtained the data, document the versions of the software you're running, and which version of the data you're working with (if applicable)

skreling commented 3 years ago
  1. Keep everything within a single directory with well-thought out names. Using leading zeroes.
  2. Keep documentation for everything in README files. Document methods and workflows, origin of all data in project directory, when data is downloaded, version information, how data was downloaded 2.5. Take time to run quality controls
jdduprey commented 3 years ago
  1. Creating a consistent directory structure so methods (and scripts) you use are reproducible for collaborators and for future you.
  2. Include documentation in README files of workflows, methods, metadata, and software version information.
laurel-nave-powers commented 3 years ago
  1. Having good project organization- clearly named files (no spaces, include extensions) all organized in one project directory. This also helps with reproducibility.
  2. Having a well documented project- document what you did, when you did it, and where you got it. This can be in a README file in your project’s main directory.
meganewing commented 3 years ago
  1. Organization (setting up a project directory, sub directories, and sub projects. Naming directories and files in a way that is consistent and understandable)
  2. Documentation (having a README file stored in your project's main direcories that includes information on software version, parameters used, workflow/methods, origin of data -- including where/when/how it was downloaded, data version, etc. And having this README file being in plain text so it can be viewed by any system any time)

Both of these are key to having a reproducible and robust project, and important for personal sanity when working with a lot of data.

dippelmax commented 3 years ago

The two most important things in setting up a bioinformatics project are documentation and organization. Documentation includes to keeping track of when, where and how data are downloaded. The text recommends storing it in plain-text README files which are portable and accessable. To organize the project, it is important to create a orderly directory with many subdirectories which are logically organized. It is imperative that your directory is understandable to you and to others who may seek to understand and/or reproduce your project.

Brybrio commented 3 years ago

The most important considerations according to the reading are directory organization and workflow documentation. I personally struggle with keeping file names consistent and subfolders organized, so I agree with the importance of standardizing names and folder organization. Also maintaining a record of the progress, code, file documentation, etc. is very necessary for future understanding and repeatability; using READMEs is a tip given in the reading.