Skip to content

Check typos and fill documentation#163

Open
Rekyt wants to merge 13 commits into
mainfrom
check_typos
Open

Check typos and fill documentation#163
Rekyt wants to merge 13 commits into
mainfrom
check_typos

Conversation

@Rekyt
Copy link
Copy Markdown
Collaborator

@Rekyt Rekyt commented May 26, 2026

A PR to improve the documentation of the package

@codecov
Copy link
Copy Markdown

codecov Bot commented May 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.36%. Comparing base (e8497bd) to head (ead033d).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #163   +/-   ##
=======================================
  Coverage   99.36%   99.36%           
=======================================
  Files          38       38           
  Lines        2039     2039           
=======================================
  Hits         2026     2026           
  Misses         13       13           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Rekyt Rekyt requested a review from ahasverus May 26, 2026 15:08
Copy link
Copy Markdown
Member

@ahasverus ahasverus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this documentation review!
Just some comments...

## Regular Plots

In this section we will describe what we call "regular plots", i.e.
In this section we will describe what we call "regular plots," i.e.,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous was better, no!?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was flagged by my grammar/typography checker. The second is more inline with actual typographic rules in American English

Comment thread vignettes/funbiogeo.Rmd
@@ -448,7 +448,7 @@ value of the CWM at this site for this trait.

## Compute functional diversity indices
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe ## Compute Functional Diversity Indices?

Comment thread vignettes/funbiogeo.Rmd


## Filter sites by trait coverage
## Filter Sites by trait Coverage
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## Filter Sites by Trait Coverage?

Comment thread vignettes/funbiogeo.Rmd


## Filter species by trait coverage
## Filter Species by trait Coverage
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## Filter Species by Trait Coverage ?

Comment thread vignettes/funbiogeo.Rmd
completeness to filter our data for our following analyses.

## Filter trait by species coverage
## Filter trait by Species Coverage
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## Filter Trait by Species Coverage?

Comment thread vignettes/long-format.Rmd


### Extracting site x locations data
### Extracting Site x locations Data
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

### Extracting Site x Locations Data?

Comment thread vignettes/long-format.Rmd


### Extracting species x categories data
### Extracting Species x categories Data
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

### Extracting Species x Categories Data?

Comment thread vignettes/upscaling.Rmd
with more than 5 species on average in the sites it harbors.


# Aggregating through a SpatRaster grid
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# Aggregating Through a SpatRaster Grid?

Comment thread vignettes/upscaling.Rmd
@@ -306,7 +299,7 @@ fb_map_raster(upscaled_richness)

## Coarsening site-species data
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## Coarsening Site x Species Data?

Comment thread vignettes/upscaling.Rmd
@@ -369,7 +360,7 @@ patchwork::wrap_plots(finer_map, coarser_map, nrow = 1)

### Obtaining back a site x species `data.frame`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

### Obtaining Back a Site x Species `data.frame`?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants