-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update compare fasta files #461
base: main
Are you sure you want to change the base?
Conversation
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add triple quotes description of module here, then use doc in main() description to point to this description.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've had a look disha, just a few things I think could be tweaked. I will leave it here for now and return. Do let me know if you disagree or find any issues with my suggested edits
Returns: | ||
argparse.Namespace: Parsed arguments as an argparse Namespace object. | ||
""" | ||
parser = ArgumentParser(description="Compare sequences between two genomes") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove Compare sequences between two genomes, replace with __doc__
Additionally, Id recommend briefly touching on what is the basis of said comparison just to make the description of the module a little clearer without digging into each diff function.
default=Path.cwd(), | ||
help="Directory to store the comparison report. Defaults to the current working directory.", | ||
) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove empty line new line break
action="store_true", | ||
help="Enable compare seq_region mode, i.e. use seq_region for seqence comparison", | ||
) | ||
return parser.parse_args(arg_list) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before return of parser, don't forgot to add parser.add_log_arguments()
""" | ||
Compare two FASTA files for common, unique, and differing sequences. | ||
""" | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May be a comment to add "Reading fasta" like in below cases ?
Co-authored-by: Lahcen Campbell <[email protected]>
Co-authored-by: Lahcen Campbell <[email protected]>
Updated compare fasta from runnables into a module. This module is mainly focused on comparing 2 fasta files, mainly with INSDC