# Inch CI

SpeciesFileGroup/taxonworks Taxonworks

Workbench for biodiversity informatics.

Refresh
#50 (all)
Ruby (change)
673 seconds
10 months ago
Build History Evaluation Suggestions 20+   Read the docs

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

Seems really good
A
ApplicationController N
A
TaxonDetermination N
A
CollectionProfile N
A
CollectionObject N
A
CollectingEvent N
Show 3093 more ...
Proper documentation present
B
TaxonNames::CatalogHelper#history_taxon_name N
B
CollectionObject.in_geographic_item N
B
GeographicItem.are_contained_in_item_by_id N
B
Workbench::FormHelper#lock_tag N
B
CollectingEvent.filter N
B
CollectionObject.from_collecting_events N
B
CollectingEvent#similar_dates N
B
Plugins::PapertrailHelper#get_highlighted_words N
B
Utilities::Hashes.puts_collisions N
B
GeographicItem.distance_between N
B
Support::Database.pg_restore N
B
Support::Database.pg_dump N
B
Download.generate_csv N
B
Georeference.with_locality_like Ne
B
Georeference.with_locality Ne
B
Georeference.with_locality_as Ne
B
Georeference::GeoLocate#api_response= Ne
B
GeographicItem.within_radius_of_item Ne
B
Shared::IsData::ClassMethods#not_ids Ne
B
LoanItem#date_returned_jquery= Ne
B
ContainerItem#global_entity= Ne
B
Queries::Query#terms= Ne
B
ActiverecordUtilities::ClassMethods#nil_trim_attributes Ne
B
SoftValidation::SoftValidationMethod#resolution= Ne
B
GeographicItem.geometry_for_collection_sql Ne
B
GeographicItem.single_geometry_sql Ne
B
GeographicItem.st_multi Ne
B
Dwca::GbifProfile::ResourceRelationship#relationshipEstablishedDate= Ne
B
Dwca::GbifProfile::ResourceRelationship#relationshipAccordingTo= Ne
B
Dwca::GbifProfile::ResourceRelationship#relationshipOfResource= Ne
B
Dwca::GbifProfile::ResourceRelationship#resourceRelationshipID= Ne
B
Dwca::GbifProfile::ResourceRelationship#relationshipRemarks= Ne
B
Dwca::GbifProfile::ResourceRelationship#relatedResourceID= Ne
B
Dwca::GbifProfile::SpeciesDistribution#establishmentMeans= Ne
B
Dwca::GbifProfile::SpeciesDistribution#occurrenceRemarks= Ne
B
Dwca::GbifProfile::SpeciesDistribution#occurrenceStatus= Ne
B
Dwca::GbifProfile::ResourceRelationship#scientificName= Ne
B
Dwca::GbifProfile::TypeSpecimen#identificationRemarks= Ne
B
Dwca::GbifProfile::TypeSpecimen#bibliographicCitation= Ne
B
Dwca::GbifProfile::SpeciesDistribution#startDayOfYear= Ne
B
Dwca::GbifProfile::CoreTaxon#scientificNameAuthorship= Ne
B
Dwca::GbifProfile::SpeciesDistribution#appendixCITES= Ne
B
Dwca::GbifProfile::TypeSpecimen#typeDesignationType= Ne
B
Dwca::GbifProfile::SpeciesDistribution#threatStatus= Ne
B
Dwca::GbifProfile::SpeciesDistribution#endDayOfYear= Ne
B
Dwca::GbifProfile::SpeciesProfile#sizeInMillimiters= Ne
B
Dwca::GbifProfile::Reference#bibliographicCitation= Ne
B
Dwca::GbifProfile::SpeciesDistribution#countryCode= Ne
B
Dwca::GbifProfile::CoreTaxon#bibliographicCitation= Ne
B
Dwca::GbifProfile::SpeciesDescription#rightsHolder= Ne
B
Dwca::GbifProfile::SpeciesDescription#contributor= Ne
B
Dwca::GbifProfile::SpeciesDistribution#locationID= Ne
B
Dwca::GbifProfile::CoreTaxon#infraspecificEpithet= Ne
B
Dwca::GbifProfile::VernacularName#isPreferredName= Ne
B
Dwca::GbifProfile::AlternateIdentifier#identifier= Ne
B
Dwca::GbifProfile::TypeSpecimen#verbatimEventDate= Ne
B
Dwca::GbifProfile::TypeSpecimen#verbatimLongitude= Ne
B
Dwca::GbifProfile::SpeciesDescription#description= Ne
B
Dwca::GbifProfile::CoreTaxon#higherClassification= Ne
B
Dwca::GbifProfile::CoreTaxon#nomenclaturalStatus= Ne
B
Dwca::GbifProfile::TypeSpecimen#typeDesignatedBy= Ne
B
Dwca::GbifProfile::SpeciesDistribution#lifeStage= Ne
B
Dwca::GbifProfile::TypeSpecimen#verbatimLatitude= Ne
B
Dwca::GbifProfile::SpeciesDistribution#eventDate= Ne
B
Dwca::GbifProfile::CoreTaxon#informationWithheld= Ne
B
Dwca::GbifProfile::CoreTaxon#originalNameUsageID= Ne
B
Dwca::GbifProfile::VernacularName#vernacularName= Ne
B
Dwca::GbifProfile::CoreTaxon#acceptedNameUsageID= Ne
B
Dwca::GbifProfile::SpeciesProfile#isTerrestrial= Ne
B
Dwca::GbifProfile::SpeciesDistribution#locality= Ne
B
Dwca::GbifProfile::ResourceRelationship#taxonID= Ne
B
Dwca::GbifProfile::TypeSpecimen#institutionCode= Ne
B
Dwca::GbifProfile::CoreTaxon#parentNameUsageID= Ne
B
Dwca::GbifProfile::CoreTaxon#verbatimTaxonRank= Ne
B
Dwca::GbifProfile::SpeciesDescription#language= Ne
B
Dwca::GbifProfile::SpeciesProfile#livingPeriod= Ne
B
Dwca::GbifProfile::CoreTaxon#nameAccordingToID= Ne
B
Dwca::GbifProfile::TypeSpecimen#collectionCode= Ne
B
Dwca::GbifProfile::AlternateIdentifier#subject= Ne
B
Dwca::GbifProfile::VernacularName#organismPart= Ne
B
Dwca::GbifProfile::SpeciesDistribution#taxonID= Ne
B
Dwca::GbifProfile::CoreTaxon#namePublishedInID= Ne
B
Dwca::GbifProfile::CoreTaxon#originalNameUsage= Ne
B
Dwca::GbifProfile::SpeciesProfile#isFreshwater= Ne
B
Dwca::GbifProfile::CoreTaxon#nomenclaturalCode= Ne
B
Dwca::GbifProfile::TypeSpecimen#scientificName= Ne
B
Dwca::GbifProfile::AlternateIdentifier#taxonID= Ne
B
Dwca::GbifProfile::VernacularName#taxonRemarks= Ne
B
Dwca::GbifProfile::SpeciesDescription#audience= Ne
B
Dwca::GbifProfile::CoreTaxon#acceptedNameUsage= Ne
B
Dwca::GbifProfile::SpeciesDescription#creator= Ne
B
Dwca::GbifProfile::SpeciesDescription#taxonID= Ne
B
Dwca::GbifProfile::CoreTaxon#scientificNameID= Ne
B
Dwca::GbifProfile::SpeciesProfile#massInGrams= Ne
B
Dwca::GbifProfile::SpeciesDistribution#source= Ne
B
Dwca::GbifProfile::SpeciesDescription#license= Ne
B
Dwca::GbifProfile::AlternateIdentifier#format= Ne
B
Dwca::GbifProfile::TypeSpecimen#verbatimLabel= Ne
B
Dwca::GbifProfile::VernacularName#countryCode= Ne
B
Dwca::GbifProfile::TypeSpecimen#catalogNumber= Ne
B
Dwca::GbifProfile::SpeciesProfile#isInvasive= Ne
B
Dwca::GbifProfile::AlternateIdentifier#title= Ne
B
Dwca::GbifProfile::CoreTaxon#parentNameUsage= Ne
B
Dwca::GbifProfile::CoreTaxon#nameAccordingTo= Ne
B
Dwca::GbifProfile::SpeciesDescription#source= Ne
B
Dwca::GbifProfile::VernacularName#locationID= Ne
B
Dwca::GbifProfile::CoreTaxon#namePublishedIn= Ne
B
Dwca::GbifProfile::TypeSpecimen#occurrenceID= Ne
B
Dwca::GbifProfile::CoreTaxon#taxonomicStatus= Ne
B
Dwca::GbifProfile::CoreTaxon#specificEpithet= Ne
B
Dwca::GbifProfile::VernacularName#lifeStage= Ne
B
Dwca::GbifProfile::SpeciesProfile#isExtinct= Ne
B
Dwca::GbifProfile::CoreTaxon#scientificName= Ne
B
Dwca::GbifProfile::SpeciesProfile#ageInDays= Ne
B
Identifier::Local#with_namespaced_identifier Ne
B
Dwca::GbifProfile::SpeciesProfile#lifeForm= Ne
B
Dwca::GbifProfile::VernacularName#isPlural= Ne
B
Dwca::GbifProfile::TypeSpecimen#recordedBy= Ne
B
Dwca::GbifProfile::VernacularName#locality= Ne
B
Dwca::GbifProfile::SpeciesDescription#type= Ne
B
Dwca::GbifProfile::VernacularName#temporal= Ne
B
Dwca::GbifProfile::VernacularName#language= Ne
B
Dwca::GbifProfile::TypeSpecimen#typeStatus= Ne
B
Dwca::GbifProfile::SpeciesProfile#isMarine= Ne
B
Dwca::GbifProfile::SpeciesProfile#isHybrid= Ne
B
Dwca::GbifProfile::SpeciesProfile#habitat= Ne
B
Dwca::GbifProfile::VernacularName#taxonID= Ne
B
Dwca::GbifProfile::CoreTaxon#rightsHolder= Ne
B
Dwca::GbifProfile::CoreTaxon#taxonRemarks= Ne
B
Dwca::GbifProfile::Reference#taxonRemarks= Ne
B
Dwca::GbifProfile::CoreTaxon#accessRights= Ne
B
Dwca::GbifProfile::SpeciesProfile#taxonID= Ne
B
Dwca::GbifProfile::TypeSpecimen#taxonRank= Ne
B
Dwca::GbifProfile::VernacularName#source= Ne
B
Dwca::GbifProfile::CoreTaxon#datasetName= Ne
B
AnnotationsHelper#annotations_summary_tag Ne
B
Dwca::GbifProfile::Reference#description= Ne
B
Dwca::GbifProfile::Reference#identifier= Ne
B
Dwca::GbifProfile::TypeSpecimen#taxonID= Ne
B
Dwca::GbifProfile::TypeSpecimen#source= Ne
B
Dwca::GbifProfile::CoreTaxon#taxonRank= Ne
B
Dwca::GbifProfile::CoreTaxon#datasetID= Ne
B
Dwca::GbifProfile::VernacularName#sex= Ne
B
Dwca::GbifProfile::SpeciesProfile#sex= Ne
B
Dwca::GbifProfile::CoreTaxon#subgenus= Ne
B
CollectingEvent#nearest_by_levenshtein Ne
B
Dwca::GbifProfile::CoreTaxon#language= Ne
B
Dwca::GbifProfile::CoreTaxon#modified= Ne
B
Dwca::GbifProfile::Reference#language= Ne
B
Dwca::GbifProfile::Reference#creator= Ne
B
Dwca::GbifProfile::CoreTaxon#taxonID= Ne
B
Dwca::GbifProfile::Reference#subject= Ne
B
Shared::IsData::ClassMethods#not_self Ne
B
Dwca::GbifProfile::CoreTaxon#kingdom= Ne
B
Dwca::GbifProfile::Reference#taxonID= Ne
B
Dwca::GbifProfile::CoreTaxon#source= Ne
B
Dwca::GbifProfile::TypeSpecimen#sex= Ne
B
Dwca::GbifProfile::CoreTaxon#family= Ne
B
Dwca::GbifProfile::Reference#rights= Ne
B
Dwca::GbifProfile::Reference#source= Ne
B
Dwca::GbifProfile::CoreTaxon#rights= Ne
B
Dwca::GbifProfile::CoreTaxon#phylum= Ne
B
Dwca::GbifProfile::CoreTaxon#genus= Ne
B
Plugins::PapertrailHelper#get_diffs Ne
B
Dwca::GbifProfile::CoreTaxon#klass= Ne
B
Dwca::GbifProfile::Reference#title= Ne
B
Dwca::GbifProfile::CoreTaxon#order= Ne
B
Dwca::GbifProfile::Reference#type= Ne
B
Dwca::GbifProfile::Reference#date= Ne
B
Workbench::StyleHelper#data_tag Ne
B
Content.generate_download Ne
B
Person#first name Ne
B
UserTasks.task Ne
B
BatchLoad::Import::TaxonNames::CastorInterpreter#parent_taxon_name_id= Ne
B
ObservationMatrixColumnItemsHelper#observation_matrix_column_item_tag Ne
B
BatchLoad::Import::TaxonNames::CastorInterpreter#nomenclature_code= Ne
B
BatchLoad::Import::TaxonNames::CastorInterpreter#parent_taxon_name= Ne
B
CollectionObjectCatalog::CatalogEntry#reference_collection_object= Ne
B
BatchLoad::Import::TaxonNames::CastorInterpreter#also_create_otu= Ne
B
CollectionProfilesHelper#collection_profile_attribute_status_tag Ne
B
TaxonNameClassificationsHelper#taxon_name_classification_options Ne
B
Queries::CollectionObjectFilterQuery#query_geographic_area_ids= Ne
B
BatchLoad::Import::TaxonifiToTaxonworks#parent_taxon_name_id= Ne
B
BatchLoad::Import::TaxonNames::CastorInterpreter#project_id= Ne
B
Distribution#get_data_for_collecting_event_geographic_areas Ne
B
BatchLoad::Import::TaxonifiToTaxonworks#parent_taxon_name= Ne
B
BatchLoad::Import::TaxonifiToTaxonworks#nomenclature_code= Ne
B
Utilities::Geo.degrees_minutes_seconds_to_decimal_degrees Ne
B
Workbench::SoftValidationHelper#soft_validation_alert_tag Ne
B
BatchLoad::Import::TaxonifiToTaxonworks#name_collection= Ne
B
BatchLoad::Import::TaxonifiToTaxonworks#also_create_otu= Ne
B
NomenclatureCatalog::CatalogEntry#reference_taxon_name= Ne
B
Housekeeping::Timestamps::ClassMethods#created_in_last Ne
B
Housekeeping::Timestamps::ClassMethods#updated_in_last Ne
B
Queries::CollectionObjectFilterQuery#user_date_start= Ne
B
Queries::CollectionObjectFilterQuery#user_date_end= Ne
B
BatchLoad::Import::TaxonifiToTaxonworks#project_id= Ne
B
Shared::Identifiable::ClassMethods#with_identifier Ne
B
CollectingEvent#collecting_events_within_radius_of Ne
B
ApplicationEnumeration.alternate_value_attributes Ne
B
NomenclatureCatalog::EntryItem#nomenclature_date= Ne
B
SoftValidation::SoftValidationMethod#description= Ne
B
Queries::CollectionObjectFilterQuery#query_shape= Ne
B
BatchLoad::ColumnResolver::Result#error_messages= Ne
B
Queries::CollectionObjectFilterQuery#start_date= Ne
B
Utilities::Dates.format_to_hours_minutes_seconds Ne
B
Housekeeping::Projects::ClassMethods#in_project Ne
B
Workbench::TableHelper#fancy_metadata_cells_tag Ne
B
Tasks::Gis::ReportController#gather_area_data_x Ne
B
Plugins::PapertrailHelper#filter_out_attributes Ne
B
Queries::CollectionObjectFilterQuery#end_date= Ne
B
CollectionObjectCatalog::EntryItem#start_date= Ne
B
Distribution#insert_for_asserted_distribution Ne
B
TaxonNamesHelper#parent_taxon_name_for_select Ne
B
NomenclatureCatalog::EntryItem#citation_date= Ne
B
ApplicationEnumeration.annotatable_attributes Ne
B
Georeference::GoogleMap#make_geographic_item Ne
B
Plugins::PapertrailHelper#get_unique_authors Ne
B
Descriptor::Gene#extend_gene_attribute_logic Ne
B
CollectionObjectCatalog::EntryItem#end_date= Ne
B
SoftValidation::SoftValidationMethod#method= Ne
B
TaxonNamesHelper#edit_taxon_name_path_string Ne
B
Workbench::NavigationHelper#edit_object_link Ne
B
CollectionObjectCatalog::CatalogEntry#items= Ne
B
Workbench::NavigationHelper#previous_object Ne
B
Combination#combination_class_relationships Ne
B
TaxonNamesHelper#taxon_name_rank_select_tag Ne
B
SoftValidation::SoftValidationMethod#klass= Ne
B
ApplicationEnumeration.model_from_file_name Ne
B
SoftValidation::SoftValidationMethod#name= Ne
B
CollectionObjectCatalog::EntryItem#object= Ne
B
Tasks::Gis::LocalityHelper#select_locality Ne
B
NomenclatureCatalog::EntryItem#taxon_name= Ne
B
SoftValidation::SoftValidations#initialize Ne
B
NomenclatureCatalog::CatalogEntry#sources= Ne
B
SoftValidation::ClassMethods#soft_validate Ne
B
SoftValidation::SoftValidationMethod#set= Ne
B
ControlledVocabularyTermsHelper#color_tag Ne
B
Workbench::NavigationHelper#previous_link Ne
B
NomenclatureCatalog::CatalogEntry#topics= Ne
B
Dwca::GbifProfile::TypeSpecimen#locality= Ne
B
BatchLoad::ColumnResolver::Result#items= Ne
B
Dwca::Import::Manager#relate_row_objects Ne
B
NomenclatureCatalog::CatalogEntry#items= Ne
B
NomenclatureCatalog::CatalogEntry#dates= Ne
B
CollectionObjectCatalog::EntryItem#type= Ne
B
NomenclatureCatalog::EntryItem#citation= Ne
B
Plugins::PapertrailHelper#get_diffs_date Ne
B
CitationsHelper#citation_author_year_tag Ne
B
Workbench::StyleHelper#toggle_class_css Ne
B
BatchLoad::ColumnResolver::Result#item= Ne
B
Workbench::NavigationHelper#next_object Ne
B
ContentsHelper#taxon_works_content_tag Ne
B
LoanItemsHelper#loan_item_total_string Ne
B
TaxonName.with_taxon_name_relationship Ne
B
Utilities::Strings.escape_single_quote Ne
B
Workbench::ObjectHelper#helper_module Ne
B
Workbench::NavigationHelper#next_link Ne
B
GeoreferencesHelper#georeference_tag Ne
B
ApplicationEnumeration.all_submodels Ne
B
BatchLoad::Import#create_attempted= Ne
B
Workbench::DisplayHelper#object_tag Ne
B
ContainersHelper#draw_container_tag Ne
B
DataAttribute.find_for_autocomplete Ne
B
BatchLoad::Import#total_data_lines= Ne
B
Utilities::Geo.error_box_for_point Ne
B
Utilities::Dates.nomenclature_date Ne
B
BatchLoad::Import#user_header_map= Ne
B
BatchLoad::Import#successful_rows= Ne
B
Descriptor::Gene#base_on_sequence= Ne
B
CollectionObject.breakdown_status Ne
B
Utilities::Geo.distance_in_meters Ne
B
Distribution#source_object_types= Ne
B
ApplicationController#meta_title= Ne
B
BatchLoad::Import#processed_rows= Ne
B
ApplicationController#meta_data= Ne
B
Utilities::Strings.random_string Ne
B
Distribution#map_source_objects= Ne
B
ApplicationController#site_name= Ne
B
GeographicItem.geometry_for_sql Ne
B
Utilities::CleanseFilename.call Ne
B
CollectionProfile#force_update= Ne
B
User#remove_page_from_favorites Ne
B
BatchLoad::Import#import_level= Ne
B
BatchLoad::Import#total_lines= Ne
B
BatchLoad::Import#file_errors= Ne
B
UserTasks::UserTask#initialize Ne
B
CollectionObject.earliest_date Ne
B
Georeference#iframe_response= Ne
B
Utilities::Hashes.delete_keys Ne
B
Georeference::GeoLocate.build Ne
B
Queries::Query#dynamic_limit= Ne
B
UserMailer#maintenance_email Ne
B
Forms::FieldLocks#initialize Ne
B
CollectionObject.latest_date Ne
B
BatchLoad::Import#processed= Ne
B
BatchLoad::RowParse#objects= Ne
B
Serial.find_for_autocomplete Ne
B
TaxonName#get_genus_species Ne
B
GeographicItem.geometry_for Ne
B
Image#height_scale_for_size Ne
B
BatchLoad::RowParse#parsed= Ne
B
User#add_page_to_favorites Ne
B
Image#width_scale_for_size Ne
B
BatchLoad::Import#errors= Ne
B
Utilities::Dates.fix_time Ne
B
GeographicItem#geometry= Ne
B
Forms::FieldLocks#locks= Ne
B
Dwca::Helper#parse_date Ne
B
ImagesHelper#image_link Ne
B
BatchLoad::Import#file= Ne
B
Content.for_page_layout Ne
B
Sequence#describe_with= Ne
B
TagsHelper#add_tag_link Ne
B
BatchLoad::Import#csv= Ne
B
Person.parse_to_people Ne
B
Utilities::Csv.to_csv Ne
B
Image#height_for_size Ne
B
Download.trim_columns Ne
B
LoanItem.batch_create Ne
B
Image#width_for_size Ne
B
HubHelper#task_card Ne
B
Serial#all_previous Ne
B
User#pinboard_hash Ne
B
Otu.for_taxon_name Ne
B
Distribution#otus= Ne
B
Download.trim_rows Ne
B
Otu.batch_preview Ne
B
Loan#clone_from= Ne
B
Person.parser Ne
B
Image.cropped Ne
B
AssertedDistribution.stub_new E
B
GeographicItem::GeometryCollection#to_hash E
B
Georeference::GeoLocate#iframe_response= E
B
Tasks::CollectingEvents::Parse::Stepwise::LatLongController#parse_filters E
B
Tasks::Accessions::Quick::SimpleController#stub E
B
Shared::Documentation#reject_documentation E
B
Dwca::Import::Manager#referenced_models E
B
Shared::Depictions#reject_depictions E
B
BatchLoad::Import::DWCA#triage E
B
Protonym#get_genus_species E
Please take a look
C
CollectingEvent.date_sql_from_dates N
C
SoftValidation::ClassMethods#soft_validators N
C
Shared::AlternateValues::ClassMethods#with_alternate_value_on N
C
GeographicArea#with_name_and_parent_name N
C
TaxonNames::CatalogHelper#history_in N
Show 502 more ...
Undocumented
U
Queries::CollectingEventLatLongExtractorQuery#initialize N
U
Queries::CollectingEventDatesExtractorQuery#initialize N
U
SoftValidation#soft_validate N
U
CollectionObjectsController N
U
CollectingEventsController N
Show 2826 more ...
Everything Inch CI

Let's raise the visibility of documentation in Open Source!

This page is for SpeciesFileGroup/taxonworks and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.

Inch CI evaluates your project's inline code documentation and reports grades for each class, module and method.

It is an open source project, created by René Föhring (@rrrene), based on Inch.

Please create an issue if anything seems broken or worthy of improvement.

Sign in with GitHub | Contact | Imprint | Data privacy | Blog